ClientRoleProvider.GetRolesForUser(String) Метод

Определение

Пространство имен:

System.Web.ClientServices.Providers

Сборка:

System.Web.Extensions.dll

Возвращает имена ролей, к которым принадлежит указанный пользователь.

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

Параметры

username

String

Имя пользователя, для которого нужно получить роли.

Возвращаемое значение

String[]

Имена ролей, к которым принадлежит username, или пустой массив, если пользователь не прошел проверку подлинности.

Исключения

ArgumentException

username Empty или null.

-или-

username не является именем пользователя текущего, прошедшего проверку подлинности.

Примеры

В следующем примере кода показано, как использовать этот метод, чтобы определить, истек ли срок действия входа пользователя до тестирования членства в роли. Этот код предполагает, что все допустимые пользователи связаны с одной или несколькими ролями. В этом случае метод GetRolesForUser не будет возвращать роли для ранее прошедшего проверку подлинности пользователя, имя входа которого истекло. Если срок действия входа пользователя истек, этот код отображает диалоговое окно входа. В противном случае вызывается метод IsUserInRole, чтобы определить, находится ли пользователь в роли "manager". Ограниченный код находится в методе PerformManagerTask, который не указан.

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

Комментарии

Метод GetRolesForUser получает сведения о роли для текущего прошедшего проверки подлинности пользователя, который необходимо указать в параметре username. Имя пользователя можно получить с помощью свойства staticThread.CurrentPrincipal следующим образом: Thread.CurrentPrincipal.Identity.Name.

Поставщик служб кэширует сведения о роли локальной файловой системы, чтобы избежать ненужных вызовов служб. Дополнительные сведения см. в обзоре класса ClientRoleProvider.

См. также раздел

• CurrentPrincipal
• IsUserInRole(String, String)
• клиентских служб приложений
• Практическое руководство. Настройка служб клиентских приложений