asp.net.ph

FormsAuthenticationEventArgs Class

System.Web.Security Namespace


Provides data for the Authenticate event of a FormsAuthenticationModule. This class cannot be inherited.

FormsAuthenticationEventArgs Class Members

Collapse   Constructors

Visibility Constructor Parameters
public FormsAuthenticationEventArgs ( HttpContext context )

Collapse   Properties

Visibility Name Value Type Accessibility
public Context HttpContext [ Get ]
public User IPrincipal [ Get , Set ]

Remarks

The FormsAuthenticationEventArgs class is used to supply event values to the FormsAuthentication_OnAuthenticate event and to enable you to specify a custom identity for the current request.

The FormsAuthenticationModule constructs a FormsAuthenticationEventArgs object using the current HttpContext and passes it to the FormsAuthentication_OnAuthenticate event.

You can use the User property to set the User property of the current HttpContext to a custom IPrincipal object.

If you do not specify a value for the User property during the FormsAuthentication_OnAuthenticate event, the identity supplied by the forms authentication ticket in the cookie or URL is used.

The FormsAuthentication_OnAuthenticate event is only raised when the authentication Mode is set to Forms and the FormsAuthenticationModule is an active HTTP module for the application.

Example

The following code example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a GenericPrincipal object with a custom Identity.

public void FormsAuthentication_OnAuthenticate ( object src, FormsAuthenticationEventArgs args ) {
   if ( FormsAuthentication.CookiesSupported ) {
      if ( Request.Cookies[FormsAuthentication.FormsCookieName] != null ) {
         try {
            FormsAuthenticationTicket ticket = FormsAuthentication.Decrypt (
               Request.Cookies [ FormsAuthentication.FormsCookieName ].Value );
            args.User = new System.Security.Principal.GenericPrincipal (
               new Samples.AspNet.Security.MyFormsIdentity ( ticket ), new string [ 0 ] );
         }
         catch ( Exception e ) {
            // Decrypt method failed.
         }
      }
   } else {
      throw new HttpException ( "Cookieless Forms Authentication is not " +
         "supported for this application." );
   }
}
  C# VB

See Also

FormsAuthenticationModule Class   FormsAuthenticationEventHandler Delegate Skip Navigation Links




Home
Suggested Reading


Previous page Back to top Next page

© 2000-2010 Rey Nuñez All rights reserved.

If you have any question, comment or suggestion
about this site, please send us a note

You can help support asp.net.ph