ClientRolePrincipal クラス

定義

クライアント アプリケーション サービスのセキュリティ情報を表します。これにはロール情報が含まれます。Represents security information for client application services, which includes role information.

public ref class ClientRolePrincipal : System::Security::Principal::IPrincipal
public class ClientRolePrincipal : System.Security.Principal.IPrincipal
type ClientRolePrincipal = class
    interface IPrincipal
Public Class ClientRolePrincipal
Implements IPrincipal
継承
ClientRolePrincipal
実装

次のコード例は、ユーザーが "manager" ロールにある場合にのみ、このクラスを使用してボタンを表示する方法を示しています。The following example code demonstrates how to use this class to display a button only when the user is in the "manager" role. この例ではButtonmanagerOnlyButtonという初期Visibleプロパティ値falseを持つという名前のが必要です。This example requires a Button named managerOnlyButton with an initial Visible property value of false.

private void DisplayButtonForManagerRole()
{
    try
    {
        ClientRolePrincipal rolePrincipal =
            System.Threading.Thread.CurrentPrincipal 
            as ClientRolePrincipal;

        if (rolePrincipal != null && rolePrincipal.IsInRole("manager"))
        {
            managerOnlyButton.Visible = true;
        }
    }
    catch (System.Net.WebException)
    {
        MessageBox.Show("Unable to access the roles service.",
            "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning);
    }
}
Private Sub DisplayButtonForManagerRole()

    Try

        Dim rolePrincipal As ClientRolePrincipal = TryCast( _
            System.Threading.Thread.CurrentPrincipal, ClientRolePrincipal)

        If rolePrincipal IsNot Nothing And _
            rolePrincipal.IsInRole("manager") Then

            managerOnlyButton.Visible = True

        End If

    Catch ex As System.Net.WebException

        MessageBox.Show("Unable to access the role service.", _
            "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning)

    End Try

End Sub

注釈

クライアントアプリケーションサービスClientFormsAuthenticationMembershipProviderでユーザーを検証する場合、 ClientWindowsAuthenticationMembershipProviderまたはは、このstaticクラスのインスタンスにThread.CurrentPrincipalプロパティを設定します。When you validate a user in client application services, the ClientFormsAuthenticationMembershipProvider or the ClientWindowsAuthenticationMembershipProvider sets the static Thread.CurrentPrincipal property to an instance of this class. ClientFormsAuthenticationMembershipProviderIdentityプロパティをClientFormsIdentityクラスの新しいインスタンスに初期化します。The ClientFormsAuthenticationMembershipProvider initializes the Identity property to a new instance of the ClientFormsIdentity class. ClientWindowsAuthenticationMembershipProvider Identity 、プロパティをメソッドによってWindowsIdentity.GetCurrent() WindowsIdentity static返されるオブジェクトに初期化します。The ClientWindowsAuthenticationMembershipProvider initializes the Identity property to the WindowsIdentity object returned by the static WindowsIdentity.GetCurrent() method.

通常、このクラスに直接アクセスすることはありません。You will not typically access this class directly. 通常は、 IsInRole CurrentPrincipalプロパティによってIPrincipal static返されるのメソッドを呼び出します。Normally, you will call the IsInRole method of the IPrincipal returned by the static CurrentPrincipal property. ただし、「例」のCurrentPrincipalセクションで示すようClientRolePrincipalに、プロパティ値IsInRoleを参照にキャストして、メソッドを明示的に呼び出すことができます。However, you can cast the CurrentPrincipal property value to a ClientRolePrincipal reference to call the IsInRole method explicitly, as demonstrated in the Example section.

コンストラクター

ClientRolePrincipal(IIdentity)

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

プロパティ

Identity

ClientRolePrincipal セキュリティ ID を取得します。Gets the security identity associated with the ClientRolePrincipal.

メソッド

Equals(Object)

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

(継承元 Object)
GetHashCode()

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

(継承元 Object)
GetType()

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

(継承元 Object)
IsInRole(String)

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

MemberwiseClone()

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

(継承元 Object)
ToString()

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

(継承元 Object)

適用対象

こちらもご覧ください