ClientRoleProvider Class

Definition

public ref class ClientRoleProvider : System::Web::Security::RoleProvider

public class ClientRoleProvider : System.Web.Security.RoleProvider

type ClientRoleProvider = class
    inherit RoleProvider

Public Class ClientRoleProvider
Inherits RoleProvider

Inheritance

Object

ProviderBase

RoleProvider

ClientRoleProvider

Examples

The following example code demonstrates how to use this property to programmatically set the roles service location.

private void SetRolesServiceLocation()
{
    ((ClientRoleProvider)System.Web.Security.Roles.Provider).ServiceUri = 
        "http://localhost:55555/AppServices/Role_JSON_AppService.axd";
}

Private Sub SetRolesServiceLocation()
    CType(System.Web.Security.Roles.Provider,  _
        ClientRoleProvider).ServiceUri = _
        "http://localhost:55555/AppServices/Role_JSON_AppService.axd"
End Sub

Remarks

You can use client application services to retrieve role information from an existing roles service by configuring your application to use the ClientRoleProvider class. After configuration, you can determine whether an authenticated user is in a particular role by calling the IsInRole method of the IPrincipal returned by the static Thread.CurrentPrincipal property. For applications configured to use client application services, this property returns a ClientRolePrincipal. Because this class implements the IPrincipal interface, you do not need to reference it explicitly. The ClientRolePrincipal.IsInRole method internally calls the ClientRoleProvider.IsUserInRole method.

The ClientRoleProvider class is a read-only role membership provider that retrieves role information for authenticated users from the roles service indicated by the ServiceUri property. The value of the ServiceUri property is typically retrieved from the application configuration file along with other configuration values.

You can retrieve the current ClientRoleProvider instance through the static Roles.Provider property.

The ClientRoleProvider class supports only the GetRolesForUser and IsUserInRole methods of the RoleProvider abstract class. When you call one of these methods for a particular user, the service provider first checks the local data cache for role information. If the cache does not contain any role information or the cache has expired, the service provider retrieves the role information from the roles service and adds it to the cache.

You can specify the time-out period for the roles cache when you configure client application services. To force the GetRolesForUser method to retrieve role data from the service instead of the local cache, call the ResetCache method first.

You cannot use the ClientRoleProvider class to create or delete roles, or to modify the role membership of users. To create or modify role information, you must change the configuration of the role service on the server.

Constructors

Properties

Methods

Applies to

See also

• CurrentPrincipal
• ClientRolePrincipal
• IsInRole(String)
• ServiceUri
• GetRolesForUser(String)
• IsUserInRole(String, String)
• ResetCache()
• Client Application Services
• How to: Configure Client Application Services