ClientFormsIdentity Class

ClientFormsIdentity Class

.NET Framework (current version)
 

Represents a user identity authenticated for client application services by using forms authentication.

Namespace:   System.Web.ClientServices
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

System.Object
  System.Web.ClientServices.ClientFormsIdentity

public class ClientFormsIdentity : IIdentity, IDisposable

NameDescription
System_CAPS_pubmethodClientFormsIdentity(String, String, MembershipProvider, String, Boolean, CookieContainer)

Initializes a new instance of the ClientFormsIdentity class.

NameDescription
System_CAPS_pubpropertyAuthenticationCookies

Gets a collection of the cookies retrieved from the authentication service.

System_CAPS_pubpropertyAuthenticationType

Gets the type of authentication that is used to authenticate the user.

System_CAPS_pubpropertyIsAuthenticated

Gets a value indicating whether the user has been authenticated.

System_CAPS_pubpropertyName

Gets the name of the user.

System_CAPS_pubpropertyProvider

Gets the membership provider that is used to authenticate the user.

NameDescription
System_CAPS_pubmethodDispose()

Releases all resources used by the ClientFormsIdentity.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the ClientFormsIdentity and optionally releases the managed resources.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRevalidateUser()

Silently authenticates the user by using cached credentials.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The client application services feature uses this class to represent an authenticated user. When you configure your application to use client application services and forms authentication, you can authenticate a user by calling the static Membership.ValidateUser method. After authentication, you can retrieve a reference to the current ClientFormsIdentity instance through the Identity property of the IPrincipal retrieved through the static Thread.CurrentPrincipal property. For more information, see Client Application Services.

You will typically access a ClientFormsIdentity object as an IIdentity reference to avoid a direct dependency on this class. You can determine whether a user is authenticated by checking the IIdentity.IsAuthenticated property of the identity. However, the user may be authenticated for Windows, but not for client application services. To determine whether the user is authenticated for client application services, you should also confirm that the IIdentity.AuthenticationType property value is "ClientForms".

You must use an explicit ClientFormsIdentity reference to call the RevalidateUser method, which is not defined by the IIdentity interface.

The following example code demonstrates how to use this class to silently revalidate a user when the application leaves the offline state. In this example, a CheckedChanged event handler updates the offline status to match the check box value. If the user sets the application to the online state, the event handler attempts to revalidate the user by calling the RevalidateUser method. However, if the authentication server is unavailable, the event handler returns the application to the offline state.

System_CAPS_noteNote

The RevalidateUser method is for convenience only. Because it does not have a return value, it cannot indicate whether revalidation has failed. Revalidation can fail, for example, if the user credentials have changed on the server. In this case, you might want to include code that explicitly validates users after a service call fails. For more information, see the Accessing Web Settings section in Walkthrough: Using Client Application Services.

private void workOfflineCheckBox_CheckedChanged(
    object sender, EventArgs e)
{
    ConnectivityStatus.IsOffline = workOfflineCheckBox.Checked;
    if (!ConnectivityStatus.IsOffline)
    {
        try
        {
            // Silently re-validate the user.
            ((ClientFormsIdentity)
                System.Threading.Thread.CurrentPrincipal.Identity)
                .RevalidateUser();

            // If any settings have been changed locally, save the new
            // new values to the Web settings service.
            SaveSettings();

            // If any settings have not been changed locally, check 
            // the Web settings service for updates. 
            Properties.Settings.Default.Reload();
        }
        catch (System.Net.WebException)
        {
            MessageBox.Show(
                "Unable to access the authentication service. " +
                Environment.NewLine + "Staying in offline mode.",
                "Warning", MessageBoxButtons.OK, 
                MessageBoxIcon.Warning);
            workOfflineCheckBox.Checked = true;
        }
    }
}

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft