ClientRoleProvider.GetRolesForUser(String) Méthode

Définition

Obtient les noms des rôles auxquels l'utilisateur spécifié appartient.

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

Paramètres

username
String

Nom de l'utilisateur pour lequel extraire des rôles.

Retours

String[]

Noms des rôles auxquels username appartient ou tableau vide si l'utilisateur n'est pas authentifié.

Exceptions

username est Empty ou null.

- ou -

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

Exemples

L’exemple de code suivant montre comment utiliser cette méthode pour déterminer si la connexion de l’utilisateur a expiré avant de tester l’appartenance au rôle. Ce code suppose que tous les utilisateurs valides sont associés à un ou plusieurs rôles. Dans ce cas, la méthode ne retourne aucun rôle pour un utilisateur précédemment authentifié dont la GetRolesForUser connexion a expiré. Si la connexion utilisateur a expiré, ce code affiche la boîte de dialogue de connexion. Sinon, il appelle la IsUserInRole méthode pour déterminer si l’utilisateur est dans le rôle « manager ». Le code restreint se trouve dans une PerformManagerTask méthode, 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

La GetRolesForUser méthode récupère les informations de rôle de l’utilisateur authentifié actuel, que vous devez spécifier dans le username paramètre . Vous pouvez obtenir le nom d’utilisateur via la staticThread.CurrentPrincipal propriété comme suit : Thread.CurrentPrincipal.Identity.Name.

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 vue d’ensemble de la ClientRoleProvider classe.

S’applique à

Voir aussi