RoleProvider Class (System.Web.Security)

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

Defines the contract that ASP.NET implements to provide role-management services using custom role providers.

Inheritance Hierarchy
System.Object
  System.Configuration.Provider.ProviderBase
    System.Web.Security.RoleProvider
      System.Web.ClientServices.Providers.ClientRoleProvider
      System.Web.Security.AuthorizationStoreRoleProvider
      System.Web.Security.SqlRoleProvider
      System.Web.Security.WindowsTokenRoleProvider

Namespace:  System.Web.Security
Assembly:  System.Web.ApplicationServices (in System.Web.ApplicationServices.dll)
Syntax
Visual Basic
Public MustInherit Class RoleProvider _
	Inherits ProviderBase
C#
public abstract class RoleProvider : ProviderBase
Visual C++
public ref class RoleProvider abstract : public ProviderBase
F#
[<AbstractClass>]
type RoleProvider =  
    class
        inherit ProviderBase
    end

The RoleProvider type exposes the following members.

Constructors
  Name Description
Protected method RoleProvider Initializes a new instance of the RoleProvider class.
Top
Properties
  Name Description
Public property ApplicationName Gets or sets the name of the application to store and retrieve role information for.
Public property Description Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs). (Inherited from ProviderBase.)
Public property Name Gets the friendly name used to refer to the provider during configuration. (Inherited from ProviderBase.)
Top
Methods
  Name Description
Public method AddUsersToRoles Adds the specified user names to the specified roles for the configured applicationName.
Public method CreateRole Adds a new role to the data source for the configured applicationName.
Public method DeleteRole Removes a role from the data source for the configured applicationName.
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 FindUsersInRole Gets an array of user names in a role where the user name contains the specified user name to match.
Public method GetAllRoles Gets a list of all the roles for the configured applicationName.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetRolesForUser Gets a list of the roles that a specified user is in for the configured applicationName.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUsersInRole Gets a list of users in the specified role for the configured applicationName.
Public method Initialize Initializes the provider. (Inherited from ProviderBase.)
Public method IsUserInRole Gets a value indicating whether the specified user is in the specified role for the configured applicationName.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RemoveUsersFromRoles Removes the specified user names from the specified roles for the configured applicationName.
Public method RoleExists Gets a value indicating whether the specified role name already exists in the role data source for the configured applicationName.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

ASP.NET role management is designed to enable you to easily use a number of different role providers for your ASP.NET applications. You can use the supplied role providers that are included with the .NET Framework, or you can implement your own provider.

When implementing a custom role provider, you are required to inherit the RoleProvider abstract class.

There are two primary reasons for creating a custom role provider.

  • You need to store role information in a data source that is not supported by the role providers included with the .NET Framework, such as a FoxPro database, an Oracle database, or other data sources.

  • You need to manage role information using a database schema that is different from the database schema used by the providers that ship with the .NET Framework. A common example of this would be role data that already exists in a SQL Server database for a company or Web site.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4
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

Implementing a Role Provider