Export (0) Print
Expand All

RolePrincipal Class

Represents security information for the current HTTP request, including role membership. This class cannot be inherited.

Namespace: System.Web.Security
Assembly: System.Web (in system.web.dll)

[SerializableAttribute] 
public sealed class RolePrincipal : IPrincipal, ISerializable
/** @attribute SerializableAttribute() */ 
public final class RolePrincipal implements IPrincipal, ISerializable
SerializableAttribute 
public final class RolePrincipal implements IPrincipal, ISerializable
Not applicable.

The RolePrincipal object implements the IPrincipal interface and represents the current security context for the HTTP request.

When role management is enabled (see Roles), the RoleManagerModule assigns a RolePrincipal object to the User property of the CurrentHttpContext.

The RolePrincipal class exposes the security identity for the current HTTP request and additionally performs checks for role membership. If CacheRolesInCookie is true, then the RolePrincipal object manages the cached list of roles and looks up role membership for the current user in the cached list first, then the role Provider. If CacheRolesInCookie is false, the RolePrincipal object always looks up role membership using the role provider.

The RolePrincipal object encrypts and decrypts role information cached in the cookie identified by the CookieName based on the CookieProtectionValue.

System.Object
  System.Web.Security.RolePrincipal

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft