ClientRoleProvider.IsUserInRole(String, String) Metoda

Reference

Definice

Obor názvů:: System.Web.ClientServices.Providers

Sestavení:: System.Web.Extensions.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Získá hodnotu určující, zda zadaný uživatel je v zadané roli.

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

Parametry

username: String

Jméno uživatele.

roleName: String

Název role.

Návraty

Boolean

true, pokud je zadaný uživatel v zadané roli; false, pokud zadaný uživatel není ověřený nebo není v zadané roli.

Výjimky

ArgumentException

username je Empty nebo null.

-nebo-

username není uživatelské jméno aktuálního ověřeného uživatele.

WebException

Uživatel se už neověřuje.

-nebo-

Služba rolí není k dispozici.

Příklady

Následující příklad kódu ukazuje, jak získat přístup k této metodě přímo určit, zda je uživatel v konkrétní roli. Tento kód nejprve otestuje, jestli vypršela platnost přihlášení uživatele. K volání metody GetRolesForUser se vyžaduje explicitní ClientRoleProvider odkaz, takže stejný odkaz se používá k volání IsUserInRole metody. Pokud je uživatel v roli "správce", tento kód volá metodu PerformManagerTask, která není k dispozici.

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

Poznámky

Ověřit, zda je ověřený uživatel v konkrétní roli voláním IsInRole metody IPrincipal vrácenou vlastností staticThread.CurrentPrincipal. Pro aplikace nakonfigurované tak, aby používaly klientské aplikační služby, vrátí tato vlastnost ClientRolePrincipal. Vzhledem k tomu, že tato třída implementuje rozhraní IPrincipal, není nutné na něj explicitně odkazovat. Metoda ClientRolePrincipal.IsInRole interně volá metodu IsUserInRole. Metoda IsUserInRole používá metodu GetRolesForUser k určení, zda je uživatel označený username v roli označené roleName.

Poskytovatel služeb ukládá informace o rolích místního systému souborů do mezipaměti, aby se zabránilo zbytečným voláním služby. Další informace najdete v přehledu třídy ClientRoleProvider.

Platí pro

Sdílet prostřednictvím