Compartir a través de

ClientRoleProvider.GetRolesForUser(String) Método

  • Referencia

Definición

Espacio de nombres:
System.Web.ClientServices.Providers
Ensamblado:
System.Web.Extensions.dll

Obtiene los nombres de los roles a los que pertenece el usuario especificado.

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()

Parámetros

username
String

Nombre completo del usuario cuyos roles se van a recuperar.

Devoluciones

String[]

Nombres de los roles a los que pertenece username o una matriz vacía si el usuario no se ha autenticado.

Excepciones

ArgumentException

username es Empty o null.

o bien

username no es el nombre del usuario autenticado actualmente.

Ejemplos

En el código de ejemplo siguiente se muestra cómo usar este método para determinar si el inicio de sesión del usuario ha expirado antes de probar la pertenencia a roles. En este código se supone que todos los usuarios válidos están asociados a uno o varios roles. En este caso, el GetRolesForUser método no devolverá ningún rol para un usuario autenticado previamente cuyo inicio de sesión haya expirado. Si el inicio de sesión del usuario ha expirado, este código muestra el cuadro de diálogo de inicio de sesión. De lo contrario, llama al IsUserInRole método para determinar si el usuario está en el rol "administrador". El código restringido está en un PerformManagerTask método , que no se proporciona.

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

Comentarios

El GetRolesForUser método recupera información de rol para el usuario autenticado actual, que debe especificar en el username parámetro . Puede obtener el nombre de usuario a través de la propiedad de la staticThread.CurrentPrincipal siguiente manera: Thread.CurrentPrincipal.Identity.Name.

El proveedor de servicios almacena en caché la información del rol sobre el sistema de archivos local para evitar llamadas de servicio innecesarias. Para obtener más información, consulte la información general de la ClientRoleProvider clase.

Se aplica a

Consulte también