ClientRoleProvider.GetRolesForUser(String) Metode

Definisi

Ruang nama:

System.Web.ClientServices.Providers

Rakitan:

System.Web.Extensions.dll

Mendapatkan nama peran milik pengguna yang ditentukan.

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

Parameter

username

String

Nama pengguna untuk mengambil peran.

Mengembalikan

String[]

Nama peran yang username milik atau array kosong jika pengguna tidak diautentikasi.

Pengecualian

ArgumentException

username Empty atau null.

-atau-

username bukan nama pengguna pengguna saat ini yang diautentikasi.

Contoh

Contoh kode berikut menunjukkan cara menggunakan metode ini untuk menentukan apakah login pengguna telah kedaluwarsa sebelum menguji keanggotaan peran. Kode ini mengasumsikan bahwa semua pengguna yang valid dikaitkan dengan satu atau beberapa peran. Dalam hal ini, metode GetRolesForUser tidak akan mengembalikan peran apa pun untuk pengguna yang diautentikasi sebelumnya yang loginnya telah kedaluwarsa. Jika login pengguna telah kedaluwarsa, kode ini akan menampilkan kotak dialog masuk. Jika tidak, ini memanggil metode IsUserInRole untuk menentukan apakah pengguna berada dalam peran "manajer". Kode terbatas berada dalam 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

Metode GetRolesForUser mengambil informasi peran untuk pengguna saat ini yang diautentikasi, yang harus Anda tentukan dalam parameter username. Anda bisa mendapatkan nama pengguna melalui properti staticThread.CurrentPrincipal sebagai berikut: Thread.CurrentPrincipal.Identity.Name.

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

Lihat juga

• CurrentPrincipal
• IsUserInRole(String, String)
• Client Application Services
• Cara: Mengonfigurasi Layanan Aplikasi Klien