ClientRoleProvider.IsUserInRole(String, String) Yöntem

Tanım

Ad Alanı:

System.Web.ClientServices.Providers

Bütünleştirilmiş Kod:

System.Web.Extensions.dll

Belirtilen kullanıcının belirtilen rolde olup olmadığını belirten bir değer alır.

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

Parametreler

username

String

Kullanıcının adı.

roleName

String

Rolün adı.

Döndürülenler

Boolean

Belirtilen kullanıcının belirtilen rolde olup olmadığını true; Belirtilen kullanıcının kimliği doğrulanmamışsa veya belirtilen rolde değilse false.

Özel durumlar

ArgumentException

username Empty veya null.

-veya-

username geçerli, kimliği doğrulanmış kullanıcının kullanıcı adı değildir.

WebException

Kullanıcının kimliği artık doğrulanmamıştır.

-veya-

Rol hizmeti kullanılamıyor.

Örnekler

Aşağıdaki örnek kod, kullanıcının belirli bir rolde olup olmadığını belirlemek için bu yönteme doğrudan nasıl erişileceğini gösterir. Bu kod önce kullanıcı oturum açma süresinin dolup dolmadığını test ediyor. GetRolesForUser yöntemini çağırmak için açık bir ClientRoleProvider başvurusu gereklidir, bu nedenle IsUserInRole yöntemini çağırmak için aynı başvuru kullanılır. Kullanıcı "yönetici" rolündeyse, bu kod sağlanmayan bir PerformManagerTask yöntemini çağırır.

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

Açıklamalar

static Thread.CurrentPrincipal özelliği tarafından döndürülen IPrincipalIsInRole yöntemini çağırarak kimliği doğrulanmış bir kullanıcının belirli bir rolde olup olmadığını belirleyebilirsiniz. İstemci uygulama hizmetlerini kullanacak şekilde yapılandırılmış uygulamalar için bu özellik bir ClientRolePrincipaldöndürür. Bu sınıf IPrincipal arabirimini uyguladığından, açıkça başvurmanız gerekmez. ClientRolePrincipal.IsInRole yöntemi dahili olarak IsUserInRole yöntemini çağırır. IsUserInRole yöntemi, username tarafından belirtilen kullanıcının roleNametarafından belirtilen rolde olup olmadığını belirlemek için GetRolesForUser yöntemini kullanır.

Hizmet sağlayıcısı, gereksiz hizmet çağrılarını önlemek için yerel dosya sistemiyle ilgili rol bilgilerini önbelleğe alır. Daha fazla bilgi için bkz. ClientRoleProvider sınıfına genel bakış.

Ayrıca bkz.

• GetRolesForUser(String)
• CurrentPrincipal
• ClientRolePrincipal
• IsInRole(String)
• İstemci Uygulama Hizmetleri