ClientRoleProvider.IsUserInRole(String, String) Methode

Referenz

Definition

Namespace:: System.Web.ClientServices.Providers

Assembly:: System.Web.Extensions.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft einen Wert ab, der angibt, ob sich der angegebene Benutzer in der angegebenen Rolle befindet.

public:
 override bool IsUserInRole(System::String ^ username, System::String ^ roleName);

public override bool IsUserInRole (string username, string roleName);

override this.IsUserInRole : string * string -> bool

Public Overrides Function IsUserInRole (username As String, roleName As String) As Boolean

Parameter

username: String

Der Name des Benutzers.

roleName: String

Der Name der Rolle.

Gibt zurück

Boolean

true, wenn sich der angegebene Benutzer in der angegebenen Rolle befindet; false, wenn der angegebene Benutzer nicht authentifiziert ist oder sich nicht in der angegebenen Rolle befindet.

Ausnahmen

ArgumentException

username ist Empty oder null.

-oder-

username ist nicht der Benutzername des aktuellen authentifizierten Benutzers.

WebException

Der Benutzer wird nicht mehr authentifiziert.

-oder-

Der Rollendienst ist nicht verfügbar.

Beispiele

Im folgenden Beispielcode wird veranschaulicht, wie Sie direkt auf diese Methode zugreifen, um zu bestimmen, ob der Benutzer in einer bestimmten Rolle ist. Dieser Code testet zuerst, ob die Benutzeranmeldung abgelaufen ist. Ein expliziter ClientRoleProvider Verweis ist erforderlich, um die GetRolesForUser-Methode aufzurufen, sodass derselbe Verweis verwendet wird, um die IsUserInRole-Methode aufzurufen. Wenn sich der Benutzer in der Rolle "Manager" befindet, ruft dieser Code eine PerformManagerTask Methode auf, die nicht bereitgestellt wird.

private void AttemptManagerTask()
{
    System.Security.Principal.IIdentity identity =
        System.Threading.Thread.CurrentPrincipal.Identity;

    // Return if the authentication type is not "ClientForms". 
    // This indicates that the user is logged out.
    if (!identity.AuthenticationType.Equals("ClientForms")) return;

    try
    {
        ClientRoleProvider provider =
            (ClientRoleProvider)System.Web.Security.Roles.Provider;
        String userName = identity.Name;

        // Determine whether the user login has expired by attempting
        // to retrieve roles from the service. Call the ResetCache method
        // to ensure that the roles are retrieved from the service. If no 
        // roles are returned, then the login has expired. This assumes 
        // that every valid user has been assigned to one or more roles.
        provider.ResetCache();
        String[] roles = provider.GetRolesForUser(userName);
        if (roles.Length == 0)
        {
            MessageBox.Show(
                "Your login has expired. Please log in again to access " +
                "the roles service.", "Attempting to access user roles...");

            // Call ValidateUser with empty strings in order to 
            // display the login dialog box configured as a 
            // credentials provider.
            if (!System.Web.Security.Membership.ValidateUser(
                String.Empty, String.Empty))
            {
                MessageBox.Show("Unable to authenticate. " +
                    "Cannot retrieve user roles.", "Not logged in",
                    MessageBoxButtons.OK, MessageBoxIcon.Error);
                return;
            }
        }

        if (provider.IsUserInRole(userName, "manager"))
        {
            PerformManagerTask();
        }
    }
    catch (System.Net.WebException)
    {
        MessageBox.Show(
            "Unable to access the remote service. " +
            "Cannot retrieve user roles.", "Warning",
            MessageBoxButtons.OK, MessageBoxIcon.Warning);
    }
}

Private Sub AttemptManagerTask()

    Dim identity As System.Security.Principal.IIdentity = _
        System.Threading.Thread.CurrentPrincipal.Identity

    ' Return if the authentication type is not "ClientForms". 
    ' This indicates that the user is logged out.
    If Not identity.AuthenticationType.Equals("ClientForms") Then Return

    Try

        Dim provider As ClientRoleProvider = _
            CType(System.Web.Security.Roles.Provider, ClientRoleProvider)
        Dim userName As String = identity.Name

        ' Determine whether the user login has expired by attempting
        ' to retrieve roles from the service. Call the ResetCache method
        ' to ensure that the roles are retrieved from the service. If no 
        ' roles are returned, then the login has expired. This assumes 
        ' that every valid user has been assigned to one or more roles.
        provider.ResetCache()
        Dim roles As String() = provider.GetRolesForUser(userName)
        If roles.Length = 0 Then

            MessageBox.Show( _
                "Your login has expired. Please log in again to access " & _
                "the roles service.", "Attempting to access user roles...")

            ' Call ValidateUser with empty strings in order to 
            ' display the login dialog box configured as a 
            ' credentials provider.
            If Not System.Web.Security.Membership.ValidateUser( _
                String.Empty, String.Empty) Then

                MessageBox.Show("Unable to authenticate. " & _
                    "Cannot retrieve user roles.", "Not logged in", _
                    MessageBoxButtons.OK, MessageBoxIcon.Error)
                Return

            End If

        End If

        If provider.IsUserInRole(userName, "manager") Then
            PerformManagerTask()
        End If

    Catch ex As System.Net.WebException

        MessageBox.Show( _
            "Unable to access the remote service. " & _
            "Cannot retrieve user roles.", "Warning", _
            MessageBoxButtons.OK, MessageBoxIcon.Warning)

    End Try

End Sub

Hinweise

Sie können ermitteln, ob sich ein authentifizierter Benutzer in einer bestimmten Rolle befindet, indem Sie die IsInRole Methode der von der staticThread.CurrentPrincipal Eigenschaft zurückgegebenen IPrincipal aufrufen. Für Anwendungen, die für die Verwendung von Clientanwendungsdiensten konfiguriert sind, gibt diese Eigenschaft eine ClientRolePrincipalzurück. Da diese Klasse die IPrincipal Schnittstelle implementiert, müssen Sie nicht explizit darauf verweisen. Die ClientRolePrincipal.IsInRole-Methode ruft intern die IsUserInRole-Methode auf. Die IsUserInRole-Methode verwendet die GetRolesForUser-Methode, um zu bestimmen, ob sich der von username angegebene Benutzer in der rolle befindet, die durch roleNameangegeben ist.

Der Dienstanbieter speichert Rolleninformationen zum lokalen Dateisystem zwischen, um unnötige Dienstaufrufe zu vermeiden. Weitere Informationen finden Sie in der ClientRoleProvider Klassenübersicht.

Gilt für:

Freigeben über