ClientRoleProvider ClientRoleProvider ClientRoleProvider ClientRoleProvider Class

定義

Microsoft Ajax ロール サービスから Windows ベースのアプリケーションのロール情報を取得します。Gets role information for Windows-based applications from an Microsoft Ajax roles service.

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
継承

次のコード例は、このプロパティを使用して、ロールサービスの場所をプログラムで設定する方法を示しています。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

注釈

クライアントアプリケーションサービスを使用すると、 ClientRoleProviderアプリケーションでクラスを使用するように構成することで、既存のロールサービスからロール情報を取得できます。You can use client application services to retrieve role information from an existing roles service by configuring your application to use the ClientRoleProvider class. 構成後、 IsInRole Thread.CurrentPrincipalプロパティによってIPrincipal static返されるのメソッドを呼び出すことによって、認証されたユーザーが特定のロールに存在するかどうかを確認できます。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. クライアント アプリケーション サービスを使用するように構成されたアプリケーションで、このプロパティは ClientRolePrincipal を返します。For applications configured to use client application services, this property returns a ClientRolePrincipal. このクラスは IPrincipal インターフェイスを実装しているため、明示的に参照する必要はありません。Because this class implements the IPrincipal interface, you do not need to reference it explicitly. メソッドClientRolePrincipal.IsInRoleは、内部的ClientRoleProvider.IsUserInRoleにメソッドを呼び出します。The ClientRolePrincipal.IsInRole method internally calls the ClientRoleProvider.IsUserInRole method.

クラスは、 ServiceUriプロパティで指定されたロールサービスから、認証されたユーザーのロール情報を取得する読み取り専用のロールメンバーシッププロバイダーです。 ClientRoleProviderThe 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. 通常、 ServiceUriプロパティの値は、アプリケーション構成ファイルから他の構成値と共に取得されます。The value of the ServiceUri property is typically retrieved from the application configuration file along with other configuration values. 詳細については、「 How to: Configure Client Application Services」を参照してください。For more information, see How to: Configure Client Application Services.

現在ClientRoleProviderのインスタンスを取得するにはstaticRoles.Providerプロパティを使用します。You can retrieve the current ClientRoleProvider instance through the static Roles.Provider property.

クラスClientRoleProviderIsUserInRole 、抽象RoleProviderクラスGetRolesForUserのメソッドとメソッドだけをサポートします。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. メソッドがGetRolesForUserローカルキャッシュではなくサービスからロールデータを取得するように強制するにResetCacheは、最初にメソッドを呼び出します。To force the GetRolesForUser method to retrieve role data from the service instead of the local cache, call the ResetCache method first.

クラスを使用しClientRoleProviderて、ロールを作成または削除したり、ユーザーのロールメンバーシップを変更したりすることはできません。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.

コンストラクター

ClientRoleProvider() ClientRoleProvider() ClientRoleProvider() ClientRoleProvider()

ClientRoleProvider クラスの新しいインスタンスを初期化します。Initializes a new instance of the ClientRoleProvider class.

プロパティ

ApplicationName ApplicationName ApplicationName ApplicationName

このプロパティは、このクラスでは使用されません。This property is not used by this class.

Description Description Description Description

管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

構成時にプロバイダーを参照するために使用される表示名を取得します。Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)
ServiceUri ServiceUri ServiceUri ServiceUri

ロール サービスの URI を取得または設定します。Gets or sets the URI of the role service.

メソッド

AddUsersToRoles(String[], String[]) AddUsersToRoles(String[], String[]) AddUsersToRoles(String[], String[]) AddUsersToRoles(String[], String[])

このメソッドは、このクラスでは使用されません。This method is not used by this class.

CreateRole(String) CreateRole(String) CreateRole(String) CreateRole(String)

このメソッドは、このクラスでは使用されません。This method is not used by this class.

DeleteRole(String, Boolean) DeleteRole(String, Boolean) DeleteRole(String, Boolean) DeleteRole(String, Boolean)

このメソッドは、このクラスでは使用されません。This method is not used by this class.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindUsersInRole(String, String) FindUsersInRole(String, String) FindUsersInRole(String, String) FindUsersInRole(String, String)

このメソッドは、このクラスでは使用されません。This method is not used by this class.

GetAllRoles() GetAllRoles() GetAllRoles() GetAllRoles()

このメソッドは、このクラスでは使用されません。This method is not used by this class.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetRolesForUser(String) GetRolesForUser(String) GetRolesForUser(String) GetRolesForUser(String)

指定したユーザーが属するロール名を取得します。Gets the names of the roles that the specified user belongs to.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
GetUsersInRole(String) GetUsersInRole(String) GetUsersInRole(String) GetUsersInRole(String)

このメソッドは、このクラスでは使用されません。This method is not used by this class.

Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection)

プロバイダーを初期化します。Initializes the provider.

IsUserInRole(String, String) IsUserInRole(String, String) IsUserInRole(String, String) IsUserInRole(String, String)

指定したユーザーが指定したロールに存在するかどうかを示す値を取得します。Gets a value indicating whether the specified user is in the specified role.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
RemoveUsersFromRoles(String[], String[]) RemoveUsersFromRoles(String[], String[]) RemoveUsersFromRoles(String[], String[]) RemoveUsersFromRoles(String[], String[])

このメソッドは、このクラスでは使用されません。This method is not used by this class.

ResetCache() ResetCache() ResetCache() ResetCache()

キャッシュされたロール情報を消去して、キャッシュのタイムアウト時間をリセットします。Clears the cached role information and resets the cache time-out period.

RoleExists(String) RoleExists(String) RoleExists(String) RoleExists(String)

このメソッドは、このクラスでは使用されません。This method is not used by this class.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください