ClientRoleProvider.IsUserInRole(String, String) Méthode

Référence

Définition

Espace de noms:: System.Web.ClientServices.Providers

Assembly:: System.Web.Extensions.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Obtient une valeur indiquant si l’utilisateur spécifié se trouve dans le rôle spécifié.

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

Paramètres

username: String

Nom de l’utilisateur.

roleName: String

Nom du rôle.

Retours

Boolean

true si l’utilisateur spécifié se trouve dans le rôle spécifié ; false si l’utilisateur spécifié n’est pas authentifié ou n’est pas dans le rôle spécifié.

Exceptions

ArgumentException

username est Empty ou null.

-ou-

username n’est pas le nom d’utilisateur de l’utilisateur actuel authentifié.

WebException

L’utilisateur n’est plus authentifié.

-ou-

Le service de rôles n’est pas disponible.

Exemples

L’exemple de code suivant montre comment accéder directement à cette méthode pour déterminer si l’utilisateur est dans un rôle particulier. Ce code teste d’abord si la connexion de l’utilisateur a expiré. Une référence de ClientRoleProvider explicite est requise pour appeler la méthode GetRolesForUser, de sorte que la même référence est utilisée pour appeler la méthode IsUserInRole. Si l’utilisateur se trouve dans le rôle « gestionnaire », ce code appelle une méthode PerformManagerTask, qui n’est pas fournie.

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

Remarques

Vous pouvez déterminer si un utilisateur authentifié se trouve dans un rôle particulier en appelant la méthode IsInRole de l'IPrincipal retournée par la propriété staticThread.CurrentPrincipal. Pour les applications configurées pour utiliser les services d’application cliente, cette propriété retourne une ClientRolePrincipal. Étant donné que cette classe implémente l’interface IPrincipal, vous n’avez pas besoin de la référencer explicitement. La méthode ClientRolePrincipal.IsInRole appelle en interne la méthode IsUserInRole. La méthode IsUserInRole utilise la méthode GetRolesForUser pour déterminer si l’utilisateur indiqué par username est dans le rôle indiqué par roleName.

Le fournisseur de services met en cache les informations de rôle sur le système de fichiers local pour éviter les appels de service inutiles. Pour plus d’informations, consultez la vue d’ensemble de la classe ClientRoleProvider.

S’applique à

Partage via