RolePrincipalとは? わかりやすく解説

RolePrincipal クラス

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

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

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

<SerializableAttribute> _
Public NotInheritable Class
 RolePrincipal
    Implements IPrincipal, ISerializable
Dim instance As RolePrincipal
[SerializableAttribute] 
public sealed class RolePrincipal : IPrincipal,
 ISerializable
[SerializableAttribute] 
public ref class RolePrincipal sealed : IPrincipal,
 ISerializable
/** @attribute SerializableAttribute() */ 
public final class RolePrincipal implements
 IPrincipal, ISerializable
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 のセキュリティ.NET Framework のセキュリティ
継承階層継承階層
System.Object
  System.Web.Security.RolePrincipal
スレッド セーフスレッド セーフ
この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照

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

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

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

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

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

Dim instance As New RolePrincipal(identity,
 encryptedTicket)
public RolePrincipal (
    IIdentity identity,
    string encryptedTicket
)
public:
RolePrincipal (
    IIdentity^ identity, 
    String^ encryptedTicket
)
public RolePrincipal (
    IIdentity identity, 
    String encryptedTicket
)
public function RolePrincipal (
    identity : IIdentity, 
    encryptedTicket : String
)

パラメータ

identity

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

encryptedTicket

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

例外例外
例外の種類条件

System.ArgumentNullException

identity が null 参照 (Visual Basic では Nothing) です。

または

encryptedTicket が null 参照 (Visual Basic では Nothing) です。

解説解説
使用例使用例

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

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
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);
}
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照

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

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

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

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

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

Dim instance As New RolePrincipal(providerName,
 identity)
public RolePrincipal (
    string providerName,
    IIdentity identity
)
public:
RolePrincipal (
    String^ providerName, 
    IIdentity^ identity
)
public RolePrincipal (
    String providerName, 
    IIdentity identity
)
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 コンストラクタ (String, IIdentity, String)

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

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

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

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

Dim instance As New RolePrincipal(providerName,
 identity, encryptedTicket)
public RolePrincipal (
    string providerName,
    IIdentity identity,
    string encryptedTicket
)
public:
RolePrincipal (
    String^ providerName, 
    IIdentity^ identity, 
    String^ encryptedTicket
)
public RolePrincipal (
    String providerName, 
    IIdentity identity, 
    String encryptedTicket
)
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 コンストラクタ (IIdentity)

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

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

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

Public Sub New ( _
    identity As IIdentity _
)
Dim identity As IIdentity

Dim instance As New RolePrincipal(identity)
public RolePrincipal (
    IIdentity identity
)
public:
RolePrincipal (
    IIdentity^ identity
)
public RolePrincipal (
    IIdentity identity
)
public function RolePrincipal (
    identity : IIdentity
)

パラメータ

identity

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

例外例外
例外の種類条件

System.ArgumentNullException

identity が null 参照 (Visual Basic では Nothing) です。

解説解説
使用例使用例

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

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
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);
}
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照

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 メソッド


パブリック メソッドパブリック メソッド

プロテクト メソッドプロテクト メソッド
明示的インターフェイスの実装明示的インターフェイスの実装
  名前 説明
インターフェイスの明示的な実装 System.Runtime.Serialization.ISerializable.GetObjectData このメンバの説明については、GetObjectData のトピックを参照してください。
参照参照

関連項目

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

その他の技術情報

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

RolePrincipal メンバ

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

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


パブリック コンストラクタパブリック コンストラクタ
パブリック プロパティパブリック プロパティ
  名前 説明
パブリック プロパティ CachedListChanged RolePrincipal オブジェクトによってキャッシュされたロール名の一覧が変更されているかどうかを示す値を取得します。
パブリック プロパティ CookiePath キャッシュされているロール名の Cookie へのパスを取得します。
パブリック プロパティ Expired ロール Cookie の有効期限が切れているかどうかを示す値を取得します。
パブリック プロパティ ExpireDate ロール Cookie の有効期限が切れる日時を取得します。
パブリック プロパティ Identity 現在の HTTP 要求のセキュリティ ID を取得します。
パブリック プロパティ IsRoleListCached ユーザーのロールの一覧が Cookie にキャッシュされているかどうかを示す値を取得します。
パブリック プロパティ IssueDate ロール Cookie が発行された日時を取得します。
パブリック プロパティ ProviderName ユーザーのロール情報を保存および取得するロール プロバイダの名前を取得します。
パブリック プロパティ Version ロール Cookie のバージョン番号を取得します。
パブリック メソッドパブリック メソッド
プロテクト メソッドプロテクト メソッド
明示的インターフェイスの実装明示的インターフェイスの実装
  名前 説明
インターフェイスの明示的な実装 System.Runtime.Serialization.ISerializable.GetObjectData このメンバの説明については、GetObjectData のトピックを参照してください。
参照参照

関連項目

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

その他の技術情報

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



英和和英テキスト翻訳

英語⇒日本語日本語⇒英語

辞書ショートカット

すべての辞書の索引

「RolePrincipal」の関連用語

RolePrincipalのお隣キーワード
検索ランキング

   

英語⇒日本語
日本語⇒英語
   



RolePrincipalのページの著作権

   
日本マイクロソフト株式会社日本マイクロソフト株式会社
© 2026 Microsoft.All rights reserved.

©2026 GRAS Group, Inc.RSS