AppleBox branding

Location :

Client application services make it easy for you to create Windows-based applications that use the Microsoft Ajax login, roles, and profile application services included in the Microsoft ASP.NET 2.0 AJAX Extensions. These services enable multiple Web and Windows-based applications to share user information and user-management functionality from a single server. For example, you can use these services to perform the following tasks: Authenticate a user.

You can use the authentication service to verify a user's identity. Determine the role or roles of an authenticated user. You can use the roles service to change the user interface of your application depending on the user's role. For example, you can provide additional features for users who are in an administrator role. Store and access per-user application settings located on the server. You can use the Web settings service (also known as the profile service) to share settings across multiple applications and locations. Client application services take advantage of the Web services extensibility model through client service providers that you can specify in your application configuration files. These service providers include offline functionality that uses a local cache for authentication, roles, and settings data when a network connection is unavailable. You can use client application services to validate a user through an existing Microsoft Ajax authentication service. You can validate a user by using Windows or forms authentication. Windows authentication means that the user identity is the one supplied by the operating system when a user logs on to a computer or domain. You will typically use Windows authentication with an application deployed on a corporate intranet. Forms authentication means that you must include login controls in your application and pass the acquired credentials to the authentication provider. You will typically use forms authentication with an application deployed on the Internet. To validate a user, you call the static MembershipValidateUser method. This method accesses the client service provider configured for your application and returns a Boolean value indicating whether the user is valid. For more information, see How to: Implement User Login with Client Application Services. When using Windows authentication, you must pass empty strings or null as the parameters of the ValidateUser method. When using Windows authentication, this method call will always return true. With forms authentication, the ValidateUser method will return a value indicating whether the remote service has authenticated the user. If validation is successful, an authentication cookie is stored on the local hard disk. This cookie is used to confirm validation when accessing the roles and settings services. When using forms authentication, you can pass a user name and password to the ValidateUser method. You can also pass empty strings or null as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the IClientFormsAuthenticationCredentialsProvider interface, which has a single method named GetCredentials. Using a credentials provider enables you to share a single login dialog box among multiple applications. For more information, see How to: Configure Client Application Services. When you configure your application to use a credentials provider with forms authentication, you must pass empty strings or null as the parameters of the ValidateUser method.

The service provider will then call your IClientFormsAuthenticationCredentialsProviderGetCredentials method implementation. Typically, you will implement this method to display a dialog box and return a populated ClientFormsAuthenticationCredentials object. For more information about authentication, see ASP.NET Authentication. For information about how to set up the Microsoft Ajax authentication service, see Using Forms Authentication with ASP.NET AJAX. You can use client application services to retrieve role information from an existing Microsoft Ajax roles service. To determine whether the current, authenticated user is in a particular role, you call the IsInRole method of the IPrincipal reference retrieved from the static ThreadCurrentPrincipal property. The IsInRole method takes the role name as a parameter and returns a Boolean value indicating whether the current user is in the specified role. This method will return false if the user is not authenticated or is not in the specified role. For more information, see How to: Access User Roles with Client Application Services. For information about how to set up the Microsoft Ajax roles service, see Using Roles Information with ASP.NET AJAX. Settings You can use client application services to retrieve user application settings from an existing Microsoft Ajax profile service. The client application services Web settings feature integrates with the application settings feature provided in .NET Framework 2.0. To retrieve Web settings, first generate a Settings class (accessed as Properties.Settings.Default in C# and My.Settings in Visual Basic) for your project by using the Settings tab of the Visual Studio project designer. On the Settings tab, you can use the Load Web Settings button to retrieve Web settings and add them to the generated Settings class. You can use Web settings configured for use by all authenticated users or by all anonymous users. For more information, see How to: Access User Settings with Client Application Services.



For more information about application settings, see Application Settings Overview. For information about how to implement your own settings class instead of generating one in Visual Studio, see How to: Create Application Settings. For information about how to set up the Microsoft Ajax profile service,

see Using Profile Information with ASP.NET AJAX. Client Application Services Classes The following table describes the classes that implement the client application services feature. Applications that use only the primary authentication, roles, and settings features will not have to access these classes directly. Instead, such applications will access the client application service providers indirectly using application configuration and the APIs described in the previous sections.

You will access these classes directly to implement additional features, such as user logout and offline capability. Note All client application services APIs are synchronous. Client application services do not directly support asynchronous behavior. The client application service providers implement or extend standard .NET Framework 2.0 types, but do not implement every member and feature defined by these types.

For example, you cannot use the client application service providers to implement a user-management application for creating new users and managing role membership.

To implement this functionality, you must currently use a Web application and server-side code. To determine which members are not implemented, see the reference documentation, which you can access from the links in this table.