SqlRoleProviderとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

SqlRoleProvider クラス

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

SQL Server データベースにある ASP.NET アプリケーションのロールメンバシップ情報の保存を管理します。

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

Visual Basic (宣言)

Public Class SqlRoleProvider
    Inherits RoleProvider

Visual Basic (使用法)

Dim instance As SqlRoleProvider

public class SqlRoleProvider : RoleProvider

C++

public ref class SqlRoleProvider : public
 RoleProvider

public class SqlRoleProvider extends RoleProvider

JScript

public class SqlRoleProvider extends
 RoleProvider

解説

このクラスは Roles クラスと RolePrincipal クラスが使用し、SQL Server データベースを使用する ASP.NET アプリケーションにロール管理サービスを提供します。ロール管理を使用すると、アプリケーションに対して複数の承認レベルを指定できます。

SqlRoleProvider クラスを使用するには、まず SqlRoleProvider が使用する SQL Server データベースを作成する必要があります。SqlRoleProvider クラスが使用するデータベースを作成するには、C:\WINDOWS\Microsoft.NET\Framework\versionNumber フォルダにある aspnet_regsql.exe 実行可能ファイルに -Ar オプションを指定して実行します (例: aspnet_regsql.exe -Ar)。作成されるデータベースは Aspnetdb という名前になります。または、aspnet_regsql.exe を実行して GUI 構成モードを起動し、すべての ASP.NET 機能を選択して構成します。

ロールプロバイダが、統合セキュリティを使用する接続文字列を使用するように設定されている場合、ASP.NET アプリケーションのプロセスアカウントには SQL Server データベースへの接続権限が必要です。

Machine.config ファイルは、AspNetSqlProvider という SqlRoleProvider のインスタンスを使用してローカルマシンの SQL Server に接続するよう構成されます。プロバイダのこのインスタンスを使用することも、ASP.NET アプリケーションの Web.config ファイルで独自に指定することもできます。AspNetSqlProvider インスタンスを使用するには、AspNetSqlProvider を roleManager 構成の defaultProvider として指定します。

認証と承認の情報に単一のデータベースを使用するには、SqlRoleProvider が SqlMembershipProvider と同じデータベースとユーザー情報を使用するように構成します。メンバシップとロールの情報に同じデータベースを使用するには、aspnet_regsql.exe 実行可能ファイルを実行してメンバシップ機能をインストールします。次に、SqlRoleProvider と SqlMembershipProvider の両方のインスタンスの構成に同じ接続文字列を指定します。この 2 つのプロバイダインスタンスを、同じ ApplicationName を使用して構成する必要もあります。

使用例

SqlRoleProvider オブジェクトと SqlMembershipProvider を使用するように構成した ASP.NET アプリケーションの Web.config ファイルの例を次に示します。authorization 要素は、Administrators ロールの認証を受けたユーザーのみにアクセスを許可するよう構成されます。

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=localhost;Integrated
 Security=SSPI;Initial Catalog=aspnetdb;" />
  </connectionStrings>
  <system.web>
    <authentication mode="Forms" >
      <forms loginUrl="logincs.aspx"
      name=".ASPXFORMSAUTH" />
    </authentication>
    <authorization>
      <deny users="?" />
         <allow roles="Administrators" />
         <deny users="*" />
    </authorization>
    <membership defaultProvider="SqlProvider" userIsOnlineTimeWindow="15">
      <providers>
        <add 
          name="SqlProvider" 
          type="System.Web.Security.SqlMembershipProvider" 
          connectionStringName="SqlServices"
          enablePasswordRetrieval="false"
          enablePasswordReset="false"
          requiresQuestionAndAnswer="false" 
          passwordFormat="Hashed" 
          applicationName="SampleApplication" />
      </providers>
    </membership>
    <roleManager defaultProvider="SqlProvider" 
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="true"
      cookieSlidingExpiration="true"
      cookieProtection="All" >
      <providers>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices" 
          applicationName="SampleApplication" />
      </providers>
    </roleManager>
  </system.web>
</configuration>

.NET Framework のセキュリティ

AspNetHostingPermission (ホスト環境で SqlRoleProvider クラスを使用するために必要なアクセス許可)要求値 : LinkDemand。アクセス許可値 : Minimal。

継承階層

System.Object
   System.Configuration.Provider.ProviderBase
     System.Web.Security.RoleProvider
      System.Web.Security.SqlRoleProvider

スレッドセーフ

この型の 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

参照

関連項目
SqlRoleProvider メンバ
System.Web.Security 名前空間
その他の技術情報
ロール管理について

SqlRoleProvider コンストラクタ

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

SqlRoleProvider クラスのインスタンスを作成します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New SqlRoleProvider

public SqlRoleProvider ()

C++

public:
SqlRoleProvider ()

public SqlRoleProvider ()

JScript

public function SqlRoleProvider ()

解説

SqlRoleProvider コンストラクタは、アプリケーションの構成に指定された SqlRoleProvider クラスのインスタンスを作成する際、ASP.NET によって呼び出されます。このコンストラクタは、コードで使用するためのものではありません。

プラットフォーム

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
サポート対象 : 2.0

参照

関連項目
SqlRoleProvider クラス
SqlRoleProvider メンバ
System.Web.Security 名前空間
その他の技術情報
ロール管理について

SqlRoleProvider プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	ApplicationName	オーバーライドされます。ロール情報を保管および取得するアプリケーションの名前を取得または設定します。
	Description	管理ツールまたは他のユーザーインターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。 ( ProviderBase から継承されます。)
	Name	構成時にプロバイダを参照するために使用される表示名を取得します。 ( ProviderBase から継承されます。)

参照

その他の技術情報

ロール管理について

SqlRoleProvider メソッド

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

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

	名前	説明
	AddUsersToRoles	オーバーライドされます。指定された各ロールに、指定されたユーザー名を追加します。
	CreateRole	オーバーライドされます。新しいロールをロールデータベースに追加します。
	DeleteRole	オーバーライドされます。ロールデータベースからロールを削除します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	FindUsersInRole	オーバーライドされます。指定されたロールで、ユーザー名が指定内容と一致するユーザーの配列を取得します。
	GetAllRoles	オーバーライドされます。アプリケーションのすべてのロールのリストを取得します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetRolesForUser	オーバーライドされます。ユーザーに割り当てられたロールのリストを取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	GetUsersInRole	オーバーライドされます。指定されたロールに属するユーザーのリストを取得します。
	Initialize	オーバーライドされます。 ASP.NET アプリケーションの構成ファイルに指定されているプロパティ値を使用して、SQL Server ロールプロバイダを初期化します。このメソッドは、コードで直接使用するためのものではありません。
	IsUserInRole	オーバーライドされます。指定されたユーザーが、指定されたロールに存在するかどうかを示す値を取得します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	RemoveUsersFromRoles	オーバーライドされます。指定されたユーザー名を指定されたロールから削除します。
	RoleExists	オーバーライドされます。指定されたロール名がロールデータベースに既に存在するかどうかを示す値を取得します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

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

参照

その他の技術情報

ロール管理について

SqlRoleProvider メンバ

SQL Server データベースにある ASP.NET アプリケーションのロールメンバシップ情報の保存を管理します。

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

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

	名前	説明
	SqlRoleProvider	SqlRoleProvider クラスのインスタンスを作成します。

パブリックプロパティ

	名前	説明
	ApplicationName	オーバーライドされます。ロール情報を保管および取得するアプリケーションの名前を取得または設定します。
	Description	管理ツールまたは他のユーザーインターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。(ProviderBase から継承されます。)
	Name	構成時にプロバイダを参照するために使用される表示名を取得します。(ProviderBase から継承されます。)

パブリックメソッド

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

	名前	説明
	AddUsersToRoles	オーバーライドされます。指定された各ロールに、指定されたユーザー名を追加します。
	CreateRole	オーバーライドされます。新しいロールをロールデータベースに追加します。
	DeleteRole	オーバーライドされます。ロールデータベースからロールを削除します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	FindUsersInRole	オーバーライドされます。指定されたロールで、ユーザー名が指定内容と一致するユーザーの配列を取得します。
	GetAllRoles	オーバーライドされます。アプリケーションのすべてのロールのリストを取得します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetRolesForUser	オーバーライドされます。ユーザーに割り当てられたロールのリストを取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	GetUsersInRole	オーバーライドされます。指定されたロールに属するユーザーのリストを取得します。
	Initialize	オーバーライドされます。 ASP.NET アプリケーションの構成ファイルに指定されているプロパティ値を使用して、SQL Server ロールプロバイダを初期化します。このメソッドは、コードで直接使用するためのものではありません。
	IsUserInRole	オーバーライドされます。指定されたユーザーが、指定されたロールに存在するかどうかを示す値を取得します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	RemoveUsersFromRoles	オーバーライドされます。指定されたユーザー名を指定されたロールから削除します。
	RoleExists	オーバーライドされます。指定されたロール名がロールデータベースに既に存在するかどうかを示す値を取得します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

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