ClientRoleProvider.IsUserInRole(String, String) Método

Referência

Definição

Namespace:: System.Web.ClientServices.Providers

Assembly:: System.Web.Extensions.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém um valor que indica se o usuário especificado está na função especificada.

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

Parâmetros

username: String

O nome do usuário.

roleName: String

O nome da função.

Retornos

Boolean

true se o usuário especificado estiver na função especificada; false se o usuário especificado não estiver autenticado ou não estiver na função especificada.

Exceções

ArgumentException

username é Empty ou null.

-ou-

username não é o nome de usuário do usuário atual e autenticado.

WebException

O usuário não está mais autenticado.

-ou-

O serviço de funções não está disponível.

Exemplos

O código de exemplo a seguir demonstra como acessar esse método diretamente para determinar se o usuário está em uma função específica. Esse código primeiro testa se o logon do usuário expirou. Uma referência ClientRoleProvider explícita é necessária para chamar o método GetRolesForUser, portanto, a mesma referência é usada para chamar o método IsUserInRole. Se o usuário estiver na função "gerente", esse código chamará um método PerformManagerTask, que não é fornecido.

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

Comentários

Você pode determinar se um usuário autenticado está em uma função específica chamando o método IsInRole do IPrincipal retornado pela propriedade staticThread.CurrentPrincipal. Para aplicativos configurados para usar serviços de aplicativo cliente, essa propriedade retorna um ClientRolePrincipal. Como essa classe implementa a interface IPrincipal, você não precisa referenciá-la explicitamente. O método ClientRolePrincipal.IsInRole chama internamente o método IsUserInRole. O método IsUserInRole usa o método GetRolesForUser para determinar se o usuário indicado por username está na função indicada por roleName.

O provedor de serviços armazena em cache informações de função sobre o sistema de arquivos local para evitar chamadas de serviço desnecessárias. Para obter mais informações, consulte a visão geral da classe ClientRoleProvider.

Aplica-se a

Compartilhar via