AuthorizationStoreRoleProvider.RoleExists メソッドとは何？わかりやすく解説 Weblio辞書

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

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

AuthorizationStoreRoleProvider.RoleExists メソッド

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

指定されたロール名が承認マネージャポリシーストアに既に存在するかどうかを示す値を取得します。

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

Visual Basic (宣言)

Public Overrides Function
 RoleExists ( _
    roleName As String _
) As Boolean

Visual Basic (使用法)

Dim instance As AuthorizationStoreRoleProvider
Dim roleName As String
Dim returnValue As Boolean

returnValue = instance.RoleExists(roleName)

public override bool RoleExists (
    string roleName
)

C++

public:
virtual bool RoleExists (
    String^ roleName
) override

public boolean RoleExists (
    String roleName
)

JScript

public override function RoleExists (
    roleName : String
) : boolean

パラメータ

roleName: 承認マネージャポリシーストアで検索するロール名。

戻り値
ロール名が承認マネージャポリシーストアに存在している場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentNullException	roleName が null 参照 (Visual Basic では Nothing) です。
ArgumentException	roleName が空の文字列です。または roleName にコンマが含まれています。
ProviderException	構成済みの applicationName が見つかりませんでした。または構成済みの scopeName が見つかりませんでした。または承認マネージャランタイムがサーバーにインストールされていません。
FileNotFoundException	connectionStringName 属性が、存在しないファイルへの接続文字列を参照しています。
HttpException	AuthorizationStoreRoleProvider インスタンスが、ファイルベースのポリシーストアを使用するように構成されていますが、そのポリシーファイルへの読み込みアクセスが現在の信頼レベルで許可されていません。

解説

RoleExists メソッドは Roles クラスによって呼び出され、ASP.NET アプリケーションの構成ファイル (Web.config) に指定されている承認マネージャデータストアにロール名が存在するかどうかを確認します。

使用例

RoleExists メソッドを使用して、ロールを作成する前にロール名が既に存在するかどうかを確認するコード例を次に示します。ロール管理を有効にする Web.config ファイルの例については、AuthorizationStoreRoleProvider のトピックを参照してください。

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security"
 %>
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load(sender As
 Object, args As EventArgs)

  If Not IsPostBack Then
    ' Bind roles to GridView.

    rolesArray = Roles.GetAllRoles()
    RolesGrid.DataSource = rolesArray
    RolesGrid.DataBind()
  End If

End Sub

Public Sub CreateRole_OnClick(sender As
 Object, args As EventArgs)

  Dim createRole As String
 = RoleTextBox.Text

  Try
    If Roles.RoleExists(createRole) Then
      Msg.Text = "Role '" & Server.HtmlEncode(createRole)
 & "' already exists. Please specify a different role name."
      Return
    End If

    Roles.CreateRole(createRole)

    Msg.Text = "Role '" & Server.HtmlEncode(createRole)
 & "' created."

    ' Re-bind roles to GridView.

    rolesArray = Roles.GetAllRoles()
    RolesGrid.DataSource = rolesArray
    RolesGrid.DataBind()
  Catch
    Msg.Text = "Role '" & Server.HtmlEncode(createRole)
 & "' <u>not</u> created."
  End Try

End Sub

</script>
<html>
<head>
<title>Sample: Create Role</title>
</head>
<body>

<form runat="server" id="PageForm">
  <h3>Create a Role</h3>

  <asp:Label id="Msg" ForeColor="maroon"
 runat="server" /><BR>

  Role name: 

  <asp:TextBox id="RoleTextBox" runat="server"
 />

  <asp:Button Text="Create Role" id="CreateRoleButton"
              runat="server" OnClick="CreateRole_OnClick"
 />

  <P>

  <asp:GridView runat="server" CellPadding="2"
 id="RolesGrid" 
                Gridlines="Both" CellSpacing="2"
 AutoGenerateColumns="false" >
    <HeaderStyle BackColor="navy" ForeColor="white"
 />
    <Columns>
      <asp:TemplateField HeaderText="Roles" runat="server"
 >
        <ItemTemplate>
          <%# Container.DataItem.ToString() %>
        </ItemTemplate>
      </asp:TemplateField>
    </Columns>
   </asp:GridView>
</form>

</body>
</html>

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<script runat="server">

string[] rolesArray;

public void Page_Load(object sender, EventArgs
 args)
{
  if (!IsPostBack)
  {
    // Bind roles to GridView.

    rolesArray = Roles.GetAllRoles();
    RolesGrid.DataSource = rolesArray;
    RolesGrid.DataBind();
  }
}

public void CreateRole_OnClick(object sender,
 EventArgs args)
{
  string createRole = RoleTextBox.Text;

  try
  {
    if (Roles.RoleExists(createRole))
    {
      Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' already
 exists. Please specify a different role name.";
      return;
    }

    Roles.CreateRole(createRole);

    Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' created.";

    // Re-bind roles to GridView.

    rolesArray = Roles.GetAllRoles();
    RolesGrid.DataSource = rolesArray;
    RolesGrid.DataBind();
  }
  catch (Exception e)
  {
    Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' <u>not</u>
 created.";
    Response.Write(e.ToString());
  }

}

</script>
<html>
<head>
<title>Sample: Create Role</title>
</head>
<body>

<form runat="server" id="PageForm">
  <h3>Create a Role</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server"
 /><BR>

  Role name: 

  <asp:TextBox id="RoleTextBox" runat="server" />

  <asp:Button Text="Create Role" id="CreateRoleButton"
              runat="server" OnClick="CreateRole_OnClick" />

  <P>

  <asp:GridView runat="server" CellPadding="2" id="RolesGrid"
 
                Gridlines="Both" CellSpacing="2" AutoGenerateColumns="false"
 >
    <HeaderStyle BackColor="navy" ForeColor="white" />
    <Columns>
      <asp:TemplateField HeaderText="Roles" runat="server"
 >
        <ItemTemplate>
          <%# Container.DataItem.ToString() %>
        </ItemTemplate>
      </asp:TemplateField>
    </Columns>
   </asp:GridView>
</form>

</body>
</html>