FormsAuthenticationEventArgs Classe

  • Referência

Definição

Namespace:
System.Web.Security
Assembly:
System.Web.dll

Fornece dados para o evento FormsAuthentication_OnAuthenticate. Essa classe não pode ser herdada.

public ref class FormsAuthenticationEventArgs sealed : EventArgs
public sealed class FormsAuthenticationEventArgs : EventArgs
type FormsAuthenticationEventArgs = class
    inherit EventArgs
Public NotInheritable Class FormsAuthenticationEventArgs
Inherits EventArgs
Herança
Object
EventArgs
FormsAuthenticationEventArgs

Exemplos

O exemplo de código a seguir usa o evento FormsAuthentication_OnAuthenticate para definir a User propriedade do atual HttpContext como um GenericPrincipal objeto com um 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

Comentários

A FormsAuthenticationEventArgs classe é usada para fornecer valores de evento para o evento FormsAuthentication_OnAuthenticate e para permitir que você especifique uma identidade personalizada para a solicitação atual.

O FormsAuthenticationModule constrói um FormsAuthenticationEventArgs objeto usando o atual HttpContext e o passa para o evento FormsAuthentication_OnAuthenticate .

Você pode usar a User propriedade para definir a User propriedade do atual HttpContext como um objeto personalizado IPrincipal .

Se você não especificar um valor para a User propriedade durante o evento FormsAuthentication_OnAuthenticate , a identidade fornecida pelo tíquete de autenticação de formulários no cookie ou url será usada.

O evento FormsAuthentication_OnAuthenticate só é gerado quando a autenticação Mode é definida Forms como e o FormsAuthenticationModule é um módulo HTTP ativo para o aplicativo.

Construtores

FormsAuthenticationEventArgs(HttpContext)

Inicializa uma nova instância da classe FormsAuthenticationEventArgs.

Propriedades

Context

Obtém o objeto HttpContext para a solicitação HTTP atual.
User

Obtém ou define o objeto IPrincipal a ser associado à solicitação atual.

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Confira também