ClientRoleProvider.IsUserInRole(String, String) Metode

Referensi

Definisi

Ruang nama:: System.Web.ClientServices.Providers

Rakitan:: System.Web.Extensions.dll

Penting

Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.

Mendapatkan nilai yang menunjukkan apakah pengguna yang ditentukan berada dalam peran yang ditentukan.

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

Parameter

username: String

Nama pengguna.

roleName: String

Nama peran.

Mengembalikan

Boolean

true jika pengguna yang ditentukan berada dalam peran yang ditentukan; false jika pengguna yang ditentukan tidak diautentikasi atau tidak berada dalam peran yang ditentukan.

Pengecualian

ArgumentException

username Empty atau null.

-atau-

username bukan nama pengguna pengguna saat ini yang diautentikasi.

WebException

Pengguna tidak lagi diautentikasi.

-atau-

Layanan peran tidak tersedia.

Contoh

Contoh kode berikut menunjukkan cara mengakses metode ini secara langsung untuk menentukan apakah pengguna berada dalam peran tertentu. Kode ini pertama kali menguji apakah login pengguna telah kedaluwarsa. Referensi ClientRoleProvider eksplisit diperlukan untuk memanggil metode GetRolesForUser, sehingga referensi yang sama digunakan untuk memanggil metode IsUserInRole. Jika pengguna berada dalam peran "manajer", kode ini memanggil metode PerformManagerTask, yang tidak disediakan.

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

Keterangan

Anda dapat menentukan apakah pengguna yang diautentikasi berada dalam peran tertentu dengan memanggil metode IsInRole IPrincipal yang dikembalikan oleh properti staticThread.CurrentPrincipal. Untuk aplikasi yang dikonfigurasi untuk menggunakan layanan aplikasi klien, properti ini mengembalikan ClientRolePrincipal. Karena kelas ini mengimplementasikan antarmuka IPrincipal, Anda tidak perlu mereferensikannya secara eksplisit. Metode ClientRolePrincipal.IsInRole secara internal memanggil metode IsUserInRole. Metode IsUserInRole menggunakan metode GetRolesForUser untuk menentukan apakah pengguna yang ditunjukkan oleh username berada dalam peran yang ditunjukkan oleh roleName.

Penyedia layanan menyimpan informasi peran tentang sistem file lokal untuk menghindari panggilan layanan yang tidak perlu. Untuk informasi selengkapnya, lihat ringkasan kelas ClientRoleProvider.

Berlaku untuk

Bagikan melalui