RolePrincipal

.NET Framework クラス ライブラリ リファレンス

RolePrincipal クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

ロール メンバシップを含む現在の HTTP 要求のセキュリティ情報を表します。このクラスは継承できません。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<SerializableAttribute> _
Public NotInheritable Class
 RolePrincipal
    Implements IPrincipal, ISerializable

Visual Basic (使用法)

Dim instance As RolePrincipal

C#

[SerializableAttribute] 
public sealed class RolePrincipal : IPrincipal,
 ISerializable

C++

[SerializableAttribute] 
public ref class RolePrincipal sealed : IPrincipal,
 ISerializable

J#

/** @attribute SerializableAttribute() */ 
public final class RolePrincipal implements
 IPrincipal, ISerializable

JScript

SerializableAttribute 
public final class RolePrincipal implements
 IPrincipal, ISerializable

解説

RolePrincipal オブジェクトは IPrincipal インターフェイスを実装し、HTTP 要求の現在のセキュリティ コンテキストを表します。

ロール管理が有効になっている場合 (Roles のトピックを参照)、RoleManagerModule は RolePrincipal オブジェクトを CurrentHttpContext の User プロパティに割り当てます。

RolePrincipal クラスは、現在の HTTP 要求のセキュリティ ID を公開し、さらにロール メンバシップのチェックを実行します。CacheRolesInCookie が true の場合、RolePrincipal オブジェクトはロールのキャッシュされた一覧を管理し、キャッシュされた一覧で現在のユーザーのロール メンバシップを検索してからロールの Provider を検索します。CacheRolesInCookie が false の場合、RolePrincipal オブジェクトはロール プロバイダを使用して常にロール メンバシップを検索します。

RolePrincipal オブジェクトは、CookieProtectionValue に基づいて CookieName によって指定される Cookie にキャッシュされたロール情報を暗号化および復号化します。

.NET Framework のセキュリティ

• System.Web.AspNetHostingPermission  ホスト環境で RolePrincipal を使用するために必要なアクセス許可。要求値 : LinkDemand。アクセス許可値 : Minimal。

継承階層

System.Object
  System.Web.Security.RolePrincipal

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RolePrincipal メンバ
System.Web.Security 名前空間
その他の技術情報
ロールを使用した承認の管理

RolePrincipal コンストラクタ (IIdentity, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定された encryptedTicket のロール情報を使用して、指定された identity の RolePrincipal オブジェクトのインスタンスを生成します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    identity As IIdentity, _
    encryptedTicket As String _
)

Visual Basic (使用法)

Dim identity As IIdentity
Dim encryptedTicket As String

Dim instance As New RolePrincipal(identity,
 encryptedTicket)

C#

public RolePrincipal (
    IIdentity identity,
    string encryptedTicket
)

C++

public:
RolePrincipal (
    IIdentity^ identity, 
    String^ encryptedTicket
)

J#

public RolePrincipal (
    IIdentity identity, 
    String encryptedTicket
)

JScript

public function RolePrincipal (
    identity : IIdentity, 
    encryptedTicket : String
)

パラメータ

identity

RolePrincipal の作成対象となるユーザーの ID。

encryptedTicket

暗号化されたロール情報を格納する文字列。

例外

例外の種類	条件
System.ArgumentNullException	identity が null 参照 (Visual Basic では Nothing) です。 または encryptedTicket が null 参照 (Visual Basic では Nothing) です。

解説

RolePrincipal コンストラクタのこのオーバーロードは RolePrincipal オブジェクトを新規作成して、そのプロパティ値を初期化します。提供されている encryptedTicket から現在のユーザーのロール情報が読み出され、RolePrincipal オブジェクトを使用してキャッシュされます。ProviderName プロパティは、既定のロール プロバイダの Name に設定されます。

ロール管理の有効化の詳細については、Roles クラスのトピックを参照してください。

使用例

新しい RolePrincipal を作成するコード例を次に示します。CacheRolesInCookie が true の場合、この例は CookieName プロパティによって指定される Cookie の情報を使用して RolePrincipal を作成します。

Visual Basic

Dim r As RolePrincipal

If Roles.CacheRolesInCookie Then
  Dim roleCookie As String
 = ""

  Dim cookie As HttpCookie = HttpContext.Current.Request.Cookies(Roles.CookieName)
  If Not cookie Is Nothing
 Then roleCookie = cookie.Value

  r = New RolePrincipal(User.Identity, roleCookie)
Else
  r = new RolePrincipal(User.Identity)
End If

C#

RolePrincipal r;

if (Roles.CacheRolesInCookie)
{
  string roleCookie = "";

  HttpCookie cookie = HttpContext.Current.Request.Cookies[Roles.CookieName];
  if (cookie != null) { roleCookie = cookie.Value;
 }

  r = new RolePrincipal(User.Identity, roleCookie);
}
else
{
  r = new RolePrincipal(User.Identity);
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RolePrincipal クラス
RolePrincipal メンバ
System.Web.Security 名前空間
その他の技術情報
ロールを使用した承認の管理

RolePrincipal コンストラクタ (String, IIdentity)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定した providerName を使用して、指定した identity の RolePrincipal オブジェクトのインスタンスを作成します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    providerName As String, _
    identity As IIdentity _
)

Visual Basic (使用法)

Dim providerName As String
Dim identity As IIdentity

Dim instance As New RolePrincipal(providerName,
 identity)

C#

public RolePrincipal (
    string providerName,
    IIdentity identity
)

C++

public:
RolePrincipal (
    String^ providerName, 
    IIdentity^ identity
)

J#

public RolePrincipal (
    String providerName, 
    IIdentity identity
)

JScript

public function RolePrincipal (
    providerName : String, 
    identity : IIdentity
)

パラメータ

providerName

ユーザーのロール プロバイダの名前。

identity

RolePrincipal を作成するユーザーの ID。

例外

例外の種類	条件
System.ArgumentNullException	identity が null 参照 (Visual Basic では Nothing) です。
System.ArgumentException	providerName が null 参照 (Visual Basic では Nothing) です。 または providerName が、アプリケーションの構成に存在しないロール プロバイダを参照しています。

解説

RolePrincipal コンストラクタのこのオーバーロードは RolePrincipal オブジェクトを新規作成して、そのプロパティ値を初期化します。ProviderName プロパティは providerName パラメータに指定された値に設定されます。

ロール管理の有効化の詳細については、Roles クラスのトピックを参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RolePrincipal クラス
RolePrincipal メンバ
System.Web.Security 名前空間
その他の技術情報
ロールを使用した承認の管理

RolePrincipal コンストラクタ (String, IIdentity, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定された encryptedTicket のロール情報と providerName を使用して、指定された identity の RolePrincipal オブジェクトのインスタンスを作成します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    providerName As String, _
    identity As IIdentity, _
    encryptedTicket As String _
)

Visual Basic (使用法)

Dim providerName As String
Dim identity As IIdentity
Dim encryptedTicket As String

Dim instance As New RolePrincipal(providerName,
 identity, encryptedTicket)

C#

public RolePrincipal (
    string providerName,
    IIdentity identity,
    string encryptedTicket
)

C++

public:
RolePrincipal (
    String^ providerName, 
    IIdentity^ identity, 
    String^ encryptedTicket
)

J#

public RolePrincipal (
    String providerName, 
    IIdentity identity, 
    String encryptedTicket
)

JScript

public function RolePrincipal (
    providerName : String, 
    identity : IIdentity, 
    encryptedTicket : String
)

パラメータ

providerName

ユーザーのロール プロバイダの名前。

identity

RolePrincipal の作成対象となるユーザーの ID。

encryptedTicket

暗号化されたロール情報を格納する文字列。

例外

例外の種類	条件
System.ArgumentNullException	identity が null 参照 (Visual Basic では Nothing) です。 または encryptedTicket が null 参照 (Visual Basic では Nothing) です。
System.ArgumentException	providerName が null 参照 (Visual Basic では Nothing) です。 または providerName が、アプリケーションの構成に存在しないロール プロバイダを参照しています。

解説

RolePrincipal コンストラクタのこのオーバーロードは RolePrincipal オブジェクトを新規作成して、そのプロパティ値を初期化します。提供されている encryptedTicket から現在のユーザーのロール情報が読み出され、RolePrincipal オブジェクトを使用してキャッシュされます。ProviderName プロパティは providerName パラメータに指定された値に設定されます。

ロール管理の有効化の詳細については、Roles クラスのトピックを参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RolePrincipal クラス
RolePrincipal メンバ
System.Web.Security 名前空間
その他の技術情報
ロールを使用した承認の管理

RolePrincipal コンストラクタ (IIdentity)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定された identity の RolePrincipal オブジェクトのインスタンスを作成します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    identity As IIdentity _
)

Visual Basic (使用法)

Dim identity As IIdentity

Dim instance As New RolePrincipal(identity)

C#

public RolePrincipal (
    IIdentity identity
)

C++

public:
RolePrincipal (
    IIdentity^ identity
)

J#

public RolePrincipal (
    IIdentity identity
)

JScript

public function RolePrincipal (
    identity : IIdentity
)

パラメータ

identity

RolePrincipal を作成するユーザーの ID。

例外

例外の種類	条件
System.ArgumentNullException	identity が null 参照 (Visual Basic では Nothing) です。

解説

RolePrincipal コンストラクタのこのオーバーロードは RolePrincipal オブジェクトを新規作成して、そのプロパティ値を初期化します。キャッシュされたロール情報は CookieName プロパティで指定される Cookie から読み込まれません。ProviderName プロパティは、既定のロール プロバイダの Name に設定されます。

ロール管理の有効化の詳細については、Roles クラスのトピックを参照してください。

使用例

新しい RolePrincipal を作成するコード例を次に示します。CacheRolesInCookie が true の場合、この例は CookieName プロパティによって指定される Cookie の情報を使用して RolePrincipal を作成します。

Visual Basic

Dim r As RolePrincipal

If Roles.CacheRolesInCookie Then
  Dim roleCookie As String
 = ""

  Dim cookie As HttpCookie = HttpContext.Current.Request.Cookies(Roles.CookieName)
  If Not cookie Is Nothing
 Then roleCookie = cookie.Value

  r = New RolePrincipal(User.Identity, roleCookie)
Else
  r = new RolePrincipal(User.Identity)
End If

C#

RolePrincipal r;

if (Roles.CacheRolesInCookie)
{
  string roleCookie = "";

  HttpCookie cookie = HttpContext.Current.Request.Cookies[Roles.CookieName];
  if (cookie != null) { roleCookie = cookie.Value;
 }

  r = new RolePrincipal(User.Identity, roleCookie);
}
else
{
  r = new RolePrincipal(User.Identity);
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RolePrincipal クラス
RolePrincipal メンバ
System.Web.Security 名前空間
その他の技術情報
ロールを使用した承認の管理
ロールを使用した承認の管理

RolePrincipal コンストラクタ

RolePrincipal クラスの新しいインスタンスを作成します。 ロールを使用した承認の管理
オーバーロードの一覧

名前	説明
RolePrincipal (IIdentity)	指定された identity の RolePrincipal オブジェクトのインスタンスを作成します。
RolePrincipal (IIdentity, String)	指定された encryptedTicket のロール情報を使用して、指定された identity の RolePrincipal オブジェクトのインスタンスを生成します。
RolePrincipal (String, IIdentity)	指定した providerName を使用して、指定した identity の RolePrincipal オブジェクトのインスタンスを作成します。
RolePrincipal (String, IIdentity, String)	指定された encryptedTicket のロール情報と providerName を使用して、指定された identity の RolePrincipal オブジェクトのインスタンスを作成します。

参照

関連項目

RolePrincipal クラス
RolePrincipal メンバ
System.Web.Security 名前空間

その他の技術情報

ロールを使用した承認の管理
ロールを使用した承認の管理

RolePrincipal プロパティ

パブリック プロパティ

	名前	説明
	CachedListChanged	RolePrincipal オブジェクトによってキャッシュされたロール名の一覧が変更されているかどうかを示す値を取得します。
	CookiePath	キャッシュされているロール名の Cookie へのパスを取得します。
	Expired	ロール Cookie の有効期限が切れているかどうかを示す値を取得します。
	ExpireDate	ロール Cookie の有効期限が切れる日時を取得します。
	Identity	現在の HTTP 要求のセキュリティ ID を取得します。
	IsRoleListCached	ユーザーのロールの一覧が Cookie にキャッシュされているかどうかを示す値を取得します。
	IssueDate	ロール Cookie が発行された日時を取得します。
	ProviderName	ユーザーのロール情報を保存および取得するロール プロバイダの名前を取得します。
	Version	ロール Cookie のバージョン番号を取得します。

参照

関連項目

RolePrincipal クラス
System.Web.Security 名前空間

その他の技術情報

ロールを使用した承認の管理

RolePrincipal メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetRoles	RolePrincipal がメンバになっているロールの一覧を取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsInRole	RolePrincipal が示すユーザーが、指定したロールに存在するかどうかを示す値を取得します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	SetDirty	キャッシュされたロールの一覧に変更済のマークを付けます。
	ToEncryptedTicket	CookieProtectionValue に基づいて暗号化されている RolePrincipal オブジェクトを使用してキャッシュされたロール情報を返します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Runtime.Serialization.ISerializable.GetObjectData	このメンバの説明については、GetObjectData のトピックを参照してください。

参照

関連項目

RolePrincipal クラス
System.Web.Security 名前空間

その他の技術情報

ロールを使用した承認の管理

RolePrincipal メンバ

ロール メンバシップを含む現在の HTTP 要求のセキュリティ情報を表します。このクラスは継承できません。

RolePrincipal データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	RolePrincipal	オーバーロードされます。 RolePrincipal クラスの新しいインスタンスを作成します。

パブリック プロパティ

	名前	説明
	CachedListChanged	RolePrincipal オブジェクトによってキャッシュされたロール名の一覧が変更されているかどうかを示す値を取得します。
	CookiePath	キャッシュされているロール名の Cookie へのパスを取得します。
	Expired	ロール Cookie の有効期限が切れているかどうかを示す値を取得します。
	ExpireDate	ロール Cookie の有効期限が切れる日時を取得します。
	Identity	現在の HTTP 要求のセキュリティ ID を取得します。
	IsRoleListCached	ユーザーのロールの一覧が Cookie にキャッシュされているかどうかを示す値を取得します。
	IssueDate	ロール Cookie が発行された日時を取得します。
	ProviderName	ユーザーのロール情報を保存および取得するロール プロバイダの名前を取得します。
	Version	ロール Cookie のバージョン番号を取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetRoles	RolePrincipal がメンバになっているロールの一覧を取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsInRole	RolePrincipal が示すユーザーが、指定したロールに存在するかどうかを示す値を取得します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	SetDirty	キャッシュされたロールの一覧に変更済のマークを付けます。
	ToEncryptedTicket	CookieProtectionValue に基づいて暗号化されている RolePrincipal オブジェクトを使用してキャッシュされたロール情報を返します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Runtime.Serialization.ISerializable.GetObjectData	このメンバの説明については、GetObjectData のトピックを参照してください。

参照

関連項目

RolePrincipal クラス
System.Web.Security 名前空間

その他の技術情報

ロールを使用した承認の管理