FormsAuthenticationEventArgs Clase

  • Referencia

Definición

Espacio de nombres:
System.Web.Security
Ensamblado:
System.Web.dll

Proporciona datos para el evento FormsAuthentication_OnAuthenticate. Esta clase no puede heredarse.

public ref class FormsAuthenticationEventArgs sealed : EventArgs
public sealed class FormsAuthenticationEventArgs : EventArgs
type FormsAuthenticationEventArgs = class
    inherit EventArgs
Public NotInheritable Class FormsAuthenticationEventArgs
Inherits EventArgs
Herencia
Object
EventArgs
FormsAuthenticationEventArgs

Ejemplos

En el ejemplo de código siguiente se usa el evento FormsAuthentication_OnAuthenticate para establecer la User propiedad del objeto actual HttpContext en un GenericPrincipal objeto con un personalizado Identity.

public void FormsAuthentication_OnAuthenticate(object sender, 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.");
  }
}

Public Sub FormsAuthentication_OnAuthenticate(sender As Object, _
                                              args As FormsAuthenticationEventArgs)
  If FormsAuthentication.CookiesSupported Then
    If Not Request.Cookies(FormsAuthentication.FormsCookieName) Is Nothing Then
      Try
        Dim ticket As FormsAuthenticationTicket = FormsAuthentication.Decrypt( _
          Request.Cookies(FormsAuthentication.FormsCookieName).Value)
        
        args.User = New System.Security.Principal.GenericPrincipal( _
          New Samples.AspNet.Security.MyFormsIdentity(ticket), _
          New String(0) {})
      Catch e As HttpException
        ' Decrypt method failed.
      End Try
    End If
  Else
      Throw New Exception("Cookieless Forms Authentication is not " & _
                            "supported for this application.")
  End If
End Sub

Comentarios

La FormsAuthenticationEventArgs clase se usa para proporcionar valores de evento al evento FormsAuthentication_OnAuthenticate y para permitirle especificar una identidad personalizada para la solicitud actual.

FormsAuthenticationModule Construye un FormsAuthenticationEventArgs objeto con el objeto actual HttpContext y lo pasa al evento FormsAuthentication_OnAuthenticate.

Puede usar la User propiedad para establecer la User propiedad del objeto actual HttpContext en un objeto personalizado IPrincipal .

Si no especifica un valor para la User propiedad durante el evento de FormsAuthentication_OnAuthenticate , se usa la identidad proporcionada por el vale de autenticación de formularios en la cookie o la dirección URL.

El evento FormsAuthentication_OnAuthenticate solo se genera cuando la autenticación Mode se establece Forms en y FormsAuthenticationModule es un módulo HTTP activo para la aplicación.

Constructores

FormsAuthenticationEventArgs(HttpContext)

Inicializa una nueva instancia de la clase FormsAuthenticationEventArgs.

Propiedades

Context

Obtiene el objeto HttpContext de la solicitud HTTP actual.
User

Obtiene y establece el objeto IPrincipal que se va a asociar a la solicitud actual.

Métodos

Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)

Se aplica a

Consulte también