RoleManagerModule Class (System.Web.Security)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
RoleManagerModule Class

Manages a RolePrincipal instance for the current user. This class cannot be inherited.

Inheritance Hierarchy
System.Object
  System.Web.Security.RoleManagerModule

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public NotInheritable Class RoleManagerModule _
	Implements IHttpModule
C#
public sealed class RoleManagerModule : IHttpModule
Visual C++
public ref class RoleManagerModule sealed : IHttpModule
F#
[<Sealed>]
type RoleManagerModule =  
    class
        interface IHttpModule
    end

The RoleManagerModule type exposes the following members.

Constructors
  Name Description
Public method RoleManagerModule Creates a new instance of the RoleManagerModule class.
Top
Methods
  Name Description
Public method Dispose Called by the HTTP runtime to dispose of the role-manager module.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Init Associates the role manager with the specified application.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Events
  Name Description
Public event GetRoles A global application event that is raised when the RoleManagerModule is ready to create a RolePrincipal that represents the current user.
Top
Remarks

The RoleManagerModule class is used to assign a RolePrincipal to the User property of the Current HttpContext.

When a request completes, the RoleManagerModule refreshes the roles cookie that contains cached role information. If the User property is of type RolePrincipal, and that RolePrincipal indicates that its cached role list has been modified by setting the CachedListChanged property to true, the RoleManagerModule will update the roles cookie that contains cached role information.

This class is not intended to be used directly from your code.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Web.Security Namespace

Other Resources

Managing Authorization Using Roles