ClientRoleProvider.IsUserInRole(String, String) Methode

Definitie

Naamruimte:
System.Web.ClientServices.Providers
Assembly:
System.Web.Extensions.dll

Hiermee wordt een waarde opgehaald die aangeeft of de opgegeven gebruiker de opgegeven rol heeft.

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

Parameters

username
String

De naam van de gebruiker.

roleName
String

De naam van de rol.

Retouren

Boolean

true als de opgegeven gebruiker zich in de opgegeven rol bevindt; false als de opgegeven gebruiker niet is geverifieerd of zich niet in de opgegeven rol bevindt.

Uitzonderingen

ArgumentException

username is Empty of null.

– of –

username is niet de gebruikersnaam van de huidige geverifieerde gebruiker.

WebException

De gebruiker wordt niet meer geverifieerd.

– of –

De functieservice is niet beschikbaar.

Voorbeelden

De volgende voorbeeldcode laat zien hoe u deze methode rechtstreeks kunt openen om te bepalen of de gebruiker een bepaalde rol heeft. Met deze code wordt eerst getest of de aanmelding van de gebruiker is verlopen. Er is een expliciete ClientRoleProvider verwijzing vereist om de GetRolesForUser methode aan te roepen, dus dezelfde verwijzing wordt gebruikt om de IsUserInRole methode aan te roepen. Als de gebruiker de rol Manager heeft, roept deze code een PerformManagerTask methode aan die niet is opgegeven.

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

Opmerkingen

U kunt bepalen of een geverifieerde gebruiker een bepaalde rol heeft door de IsInRole methode aan te roepen van de IPrincipal geretourneerde staticThread.CurrentPrincipal eigenschap. Voor toepassingen die zijn geconfigureerd voor het gebruik van clienttoepassingsservices, retourneert deze eigenschap een ClientRolePrincipal. Omdat deze klasse de IPrincipal interface implementeert, hoeft u er niet expliciet naar te verwijzen. De ClientRolePrincipal.IsInRole methode roept de methode intern aan IsUserInRole . De IsUserInRole methode gebruikt de GetRolesForUser methode om te bepalen of de gebruiker die wordt aangegeven, de rol heeft die wordt aangegeven username door roleName.

De serviceprovider slaat rolgegevens over het lokale bestandssysteem in de cache op om onnodige service-aanroepen te voorkomen. Zie het ClientRoleProvider klasoverzicht voor meer informatie.

Van toepassing op

Zie ook