ClientRoleProvider.IsUserInRole(String, String) Metodo

Riferimento

Definizione

Spazio dei nomi:: System.Web.ClientServices.Providers

Assembly:: System.Web.Extensions.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Ottiene un valore che indica se l'utente specificato si trova nel ruolo specificato.

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

Parametri

username: String

Nome dell'utente.

roleName: String

Nome del ruolo.

Restituisce

Boolean

true se l'utente specificato è nel ruolo specificato; false se l'utente specificato non è autenticato o non è nel ruolo specificato.

Eccezioni

ArgumentException

username è Empty o null.

-o-

username non è il nome utente dell'utente autenticato corrente.

WebException

L'utente non è più autenticato.

-o-

Il servizio ruoli non è disponibile.

Esempio

Il codice di esempio seguente illustra come accedere direttamente a questo metodo per determinare se l'utente si trova in un ruolo specifico. Questo codice verifica prima se l'account di accesso utente è scaduto. Per chiamare il metodo GetRolesForUser è necessario un riferimento esplicito ClientRoleProvider, quindi viene usato lo stesso riferimento per chiamare il metodo IsUserInRole. Se l'utente è nel ruolo "manager", questo codice chiama un metodo PerformManagerTask, che non viene fornito.

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

Commenti

È possibile determinare se un utente autenticato si trova in un ruolo specifico chiamando il metodo IsInRole del IPrincipal restituito dalla proprietà staticThread.CurrentPrincipal. Per le applicazioni configurate per l'uso dei servizi dell'applicazione client, questa proprietà restituisce un ClientRolePrincipal. Poiché questa classe implementa l'interfaccia IPrincipal, non è necessario farvi riferimento in modo esplicito. Il metodo ClientRolePrincipal.IsInRole chiama internamente il metodo IsUserInRole. Il metodo IsUserInRole usa il metodo GetRolesForUser per determinare se l'utente indicato da username è nel ruolo indicato da roleName.

Il provider di servizi memorizza nella cache le informazioni sul ruolo sul file system locale per evitare chiamate di servizio non necessarie. Per altre informazioni, vedere panoramica della classe ClientRoleProvider.

Si applica a

Condividi tramite