ClientRoleProvider.GetRolesForUser(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 die Namen der Rollen ab, zu denen der angegebene Benutzer gehört.

public:
 override cli::array <System::String ^> ^ GetRolesForUser(System::String ^ username);

public override string[] GetRolesForUser (string username);

override this.GetRolesForUser : string -> string[]

Public Overrides Function GetRolesForUser (username As String) As String()

Parameter

username: String

Der Name des Benutzers, für den Rollen abgerufen werden.

Gibt zurück

String[]

Die Rollennamen, zu denen username gehört, oder ein leeres Array, wenn der Benutzer nicht authentifiziert wurde.

Ausnahmen

ArgumentException

username ist Empty oder null.

- oder -

username ist nicht der Benutzername des aktuellen authentifizierten Benutzers.

Beispiele

Der folgende Beispielcode veranschaulicht, wie Sie diese Methode verwenden, um zu ermitteln, ob die Benutzeranmeldung abgelaufen ist, bevor Sie die Rollenmitgliedschaft testen. Bei diesem Code wird davon ausgegangen, dass alle gültigen Benutzer einer oder mehreren Rollen zugeordnet sind. In diesem Fall gibt die GetRolesForUser Methode keine Rollen für einen zuvor authentifizierten Benutzer zurück, dessen Anmeldung abgelaufen ist. Wenn die Benutzeranmeldung abgelaufen ist, zeigt dieser Code das Dialogfeld Anmeldung an. Andernfalls wird die IsUserInRole -Methode aufgerufen, um zu bestimmen, ob der Benutzer in der Rolle "Manager" ist. Der eingeschränkte Code befindet sich in einer PerformManagerTask Methode, 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

Die GetRolesForUser -Methode ruft Rolleninformationen für den aktuellen authentifizierten Benutzer ab, die Sie im username Parameter angeben müssen. Sie können den Benutzernamen über die staticThread.CurrentPrincipal -Eigenschaft wie folgt abrufen: Thread.CurrentPrincipal.Identity.Name.

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