ClientRoleProvider クラス

  • リファレンス

定義

名前空間:
System.Web.ClientServices.Providers
アセンブリ:
System.Web.Extensions.dll

Microsoft Ajax ロール サービスから Windows ベースのアプリケーションのロール情報を取得します。

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
継承
Object
ProviderBase
RoleProvider
ClientRoleProvider

例

次のコード例は、このプロパティを使用して、プログラムによってロール サービスの場所を設定する方法を示しています。

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 取得できます。 構成後、 プロパティによってThread.CurrentPrincipalstatic返される の メソッドを呼び出IsInRoleすことで、認証されたユーザーが特定のIPrincipalロールに含まれているかどうかを判断できます。 クライアント アプリケーション サービスを使用するように構成されたアプリケーションで、このプロパティは ClientRolePrincipal を返します。 このクラスは IPrincipal インターフェイスを実装しているため、明示的に参照する必要はありません。 メソッドは ClientRolePrincipal.IsInRole 内部的に メソッドを ClientRoleProvider.IsUserInRole 呼び出します。

クラスは ClientRoleProvider 読み取り専用ロール メンバーシップ プロバイダーであり、 プロパティによって示されるロール サービスから認証済みユーザーのロール情報を ServiceUri 取得します。 プロパティの ServiceUri 値は、通常、他の構成値と共にアプリケーション構成ファイルから取得されます。

プロパティを使用して、現在 ClientRoleProvider のインスタンスを staticRoles.Provider 取得できます。

クラスは ClientRoleProvider 、抽象クラスの GetRolesForUser メソッドと IsUserInRole メソッド RoleProvider のみをサポートします。 特定のユーザーに対してこれらのメソッドのいずれかを呼び出すと、サービス プロバイダーは最初にローカル データ キャッシュでロール情報を確認します。 キャッシュにロール情報が含まれていないか、キャッシュの有効期限が切れている場合、サービス プロバイダーはロール サービスからロール情報を取得してキャッシュに追加します。

クライアント アプリケーション サービスを構成するときに、ロール キャッシュのタイムアウト期間を指定できます。 GetRolesForUserローカル キャッシュではなくサービスからロール データを強制的に取得するには、最初に メソッドをResetCache呼び出します。

クラスを ClientRoleProvider 使用してロールを作成または削除したり、ユーザーのロール メンバーシップを変更したりすることはできません。 ロール情報を作成または変更するには、サーバー上のロール サービスの構成を変更する必要があります。

コンストラクター

ClientRoleProvider()

ClientRoleProvider クラスの新しいインスタンスを初期化します。

プロパティ

ApplicationName

このプロパティは、このクラスでは使用されません。
Description

管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。

(継承元 ProviderBase)
Name

構成時にプロバイダーを参照するために使用される表示名を取得します。

(継承元 ProviderBase)
ServiceUri

ロール サービスの URI を取得または設定します。

メソッド

AddUsersToRoles(String[], String[])

このメソッドは、このクラスでは使用されません。
CreateRole(String)

このメソッドは、このクラスでは使用されません。
DeleteRole(String, Boolean)

このメソッドは、このクラスでは使用されません。
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
FindUsersInRole(String, String)

このメソッドは、このクラスでは使用されません。
GetAllRoles()

このメソッドは、このクラスでは使用されません。
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetRolesForUser(String)

指定したユーザーが属するロール名を取得します。
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
GetUsersInRole(String)

このメソッドは、このクラスでは使用されません。
Initialize(String, NameValueCollection)

プロバイダーを初期化します。
IsUserInRole(String, String)

指定したユーザーが指定したロールに存在するかどうかを示す値を取得します。
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
RemoveUsersFromRoles(String[], String[])

このメソッドは、このクラスでは使用されません。
ResetCache()

キャッシュされたロール情報を消去して、キャッシュのタイムアウト時間をリセットします。
RoleExists(String)

このメソッドは、このクラスでは使用されません。
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください