CookieHandler Clase

Definición

Proporciona una clase base abstracta para leer, escribir, y eliminar las cookies de sesión en un cliente HTTP.Provides an abstract base class for reading, writing, and deleting session cookies on an HTTP client.

public ref class CookieHandler abstract
public abstract class CookieHandler
type CookieHandler = class
Public MustInherit Class CookieHandler
Herencia
CookieHandler
Derivado

Ejemplos

En el ejemplo siguiente se configura el SAM para usar un controlador de cookies personalizado MyNamespace.MyCustomCookieHandlerde tipo.The following example configures the SAM to use a custom cookie handler of type MyNamespace.MyCustomCookieHandler.

<cookieHandler mode="Custom">  
    <customCookieHandler type="MyNamespace.MyCustomCookieHandler, MyAssembly" />  
</cookieHandler>  

Comentarios

(SAM) utiliza una instancia de la CookieHandler clase para leer, escribir y eliminar la cookie SessionSecurityToken o las cookies que contienen en el cliente http. SessionAuthenticationModuleThe SessionAuthenticationModule (SAM) uses an instance of the CookieHandler class to read, write, and delete the cookie or cookies that contain the SessionSecurityToken on the HTTP client. La cookie (o cookies, en el caso de que el token de sesión se divida en varias cookies) que contiene el token de sesión se conoce como cookie de sesión.The cookie (or cookies, in the case where the session token is split across several cookies) that contains the session token is known as the session cookie.

Windows Identity Foundation (WIF) se distribuye con un controlador de cookies denominado controlador de cookies fragmentado implementado por la ChunkedCookieHandler clase.Windows Identity Foundation (WIF) ships with a cookie handler called the chunked cookie handler that is implemented by the ChunkedCookieHandler class. El controlador de cookies fragmentado divide el token de sesión en una o más cookies según un tamaño de fragmento especificado.The chunked cookie handler splits the session token across one or more cookies according to a specified chunk size. Esto se debe a cumplir las limitaciones de tamaño de las cookies individuales impuestas por muchos exploradores.This is to meet size limitations on individual cookies imposed by many browsers.

Puede derivar de CookieHandler para crear su propio controlador de cookies.You can derive from CookieHandler to create your own cookie handler. Al hacerlo, debe invalidar los DeleteCoremétodos, ReadCorey WriteCore para realizar el trabajo real de eliminación, lectura y escritura de la cookie de sesión.When you do so, you must override the DeleteCore, ReadCore, and WriteCore methods to perform the actual work of deleting, reading, and writing the session cookie. Estos métodos normalmente leen la cookie de la HttpRequest.Cookies colección y escriben o eliminan cookies a través de la HttpResponse.Cookies colección.These methods typically read the cookie from the HttpRequest.Cookies collection and write or delete cookies through the HttpResponse.Cookies collection. El HttpContext objeto a través del cual se puede tener acceso a la solicitud y la respuesta se proporciona como un parámetro a cada uno de estos métodos.The HttpContext object through which you can access the request and response is provided as a parameter to each of these methods. Además de los métodos necesarios, puede reemplazar opcionalmente otras propiedades de métodos virtuales expuestas por CookieHandler la clase para personalizar el comportamiento del controlador.In addition to the required methods, you can optionally override other virtual methods properties exposed by the CookieHandler class to customize the behavior of your handler.

La CookieHandler clase expone varias propiedades que especifican el comportamiento y las propiedades predeterminadas de la cookie de sesión.Several properties are exposed by the CookieHandler class that specify default behavior and properties for the session cookie. Las Namepropiedades Domain, yPath proporcionan el nombre base de la cookie, el dominio en el que es válido y la ruta de acceso en la que se almacena en el cliente.The Name, Domain, and Path properties supply the base name for the cookie, the domain in which it is valid and the path under which it is stored on the client. La HideFromClientScript propiedad especifica si la cookie es accesible para los scripts del lado cliente.The HideFromClientScript property specifies whether the cookie is accessible to client-side scripts. La RequireSsl propiedad especifica si la cookie se debe transmitir solo a través de conexiones seguras (https).The RequireSsl property specifies whether the cookie should be transmitted only over secure (HTTPS) connections. Si se establece, PersistentSessionLifetime la propiedad se usa para establecer la hora de expiración de las sesiones persistentes, es decir, para las sesiones que siguen siendo válidas incluso después de cerrar el explorador.If set, the PersistentSessionLifetime property is used to set the expiration time for persistent sessions, that is for sessions that remain valid even after the browser is closed. Todas estas propiedades tienen propiedades equivalentes que se establecen normalmente en el objeto HttpCookie (u objetos) subyacentes por los métodos "Core" del controlador.All of these properties have equivalent properties that are typically set on the underlying HttpCookie object (or objects) by the "core" methods of the handler. Para obtener más información, vea la documentación de cada propiedad.For more information see the documentation for each property.

El controlador de cookies que usa Sam puede especificarse en la configuración mediante el <elemento> cookieHandler .The cookie handler that is used by the SAM can be specified in configuration through the <cookieHandler> element. El controlador de cookies establecido por este elemento se puede modificar en un delegado de FederatedAuthentication.FederationConfigurationCreated eventos para el evento o se puede establecer o tener acceso a SessionAuthenticationModule.CookieHandler él directamente a través de la propiedad.The cookie handler set by this element can be modified in an event delegate for the FederatedAuthentication.FederationConfigurationCreated event or it can be set or accessed directly through the SessionAuthenticationModule.CookieHandler property.

Constructores

CookieHandler()

Se llama desde constructores de clases derivadas para inicializar la clase CookieHandler.Called from constructors in derived classes to initialize the CookieHandler class.

Propiedades

Domain

Obtiene o establece el dominio usado para las cookies.Gets or sets the domain used for cookies.

HideFromClientScript

Obtiene o establece un valor que indica si la cookie se debe ocultar del script cliente.Gets or sets a value that indicates whether the cookie should be hidden from client script.

Name

Obtiene o establece el nombre base para las cookies escritas por el controlador.Gets or sets the base name for cookies written by the handler.

Path

Obtiene o establece el valor de la ruta virtual para las cookies creadas por el controlador.Gets or sets the virtual path for cookies written by the handler.

PersistentSessionLifetime

Duración de sesiones persistentes.The lifetime of persistent sessions. Si es cero, siempre se usan sesiones transitorias.If zero, transient sessions are always used.

RequireSsl

Obtiene o establece un valor que especifica si la cookie se debe usar solo con SSL.Gets or sets a value that specifies whether the cookie should be used only with SSL.

Métodos

Delete()

Elimina la cookie asociada con la solicitud actual que tiene el nombre, la ruta de acceso y el dominio predeterminados.Deletes the cookie associated with the current request that has the default name, domain, and path.

Delete(HttpContext)

Elimina la cookie asociada con la solicitud actual que tiene el nombre, la ruta de acceso y el dominio predeterminados.Deletes the cookie associated with the current request that has the default name, domain, and path.

Delete(String)

Elimina la cookie asociada con la solicitud actual que tiene el nombre especificado, y el dominio y la ruta de acceso predeterminados.Deletes the cookie associated with the current request that has the specified name and the default domain and path.

Delete(String, HttpContext)

Elimina la cookie asociada con la solicitud especificada que tiene el nombre especificado, y el dominio y la ruta de acceso predeterminados.Deletes the cookie associated with the specified request that has the specified name and the default domain and path.

Delete(String, String, String, HttpContext)

Elimina la cookie asociada con la solicitud especificada que tiene el nombre, la ruta de acceso y el dominio especificados.Deletes the cookie associated with the specified request that has the specified name, path, and domain.

DeleteCore(String, String, String, HttpContext)

Cuando se reemplaza en una clase derivada, elimina la cookie asociada a la solicitud especificada que tiene el nombre, el dominio y la ruta de acceso especificados.When overridden in a derived class, deletes the cookie associated with the specified request that has the specified name, domain, and path.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
MatchCookiePath(Uri, Uri)

Si el dominio de destino está dentro del dominio de la cookie y la ruta de acceso de destino está dentro de la ruta de acceso de la cookie, coincide con el uso de mayúsculas y minúsculas de la parte de la ruta de acceso de la cookie.If the target domain is within the cookie domain and the target path is within the cookie path, match the casing of the cookie path portion.

MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
Read()

Lee la cookie asociada con la solicitud actual que tiene el nombre predeterminado.Reads the cookie associated with the current request that has the default name.

Read(HttpContext)

Lee la cookie asociada con la solicitud actual que tiene el nombre, la ruta de acceso y el dominio predeterminados.Reads the cookie associated with the current request that has the default name, domain, and path.

Read(String)

Lee la cookie asociada con la solicitud actual que tiene el nombre especificado.Reads the cookie associated with the current request that has the specified name.

Read(String, HttpContext)

Lee la cookie asociada con la solicitud especificada que tiene el nombre especificado y el dominio y la ruta de acceso predeterminados.Reads the cookie associated with the specified request that has the specified name and the default domain and path.

ReadCore(String, HttpContext)

Cuando se reemplaza en una clase derivada, lee la cookie que tiene el nombre especificado y que está asociada a la solicitud especificada.When overridden in a derived class, reads the cookie that has the specified name and that is associated with the specified request.

ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)
Write(Byte[], Boolean, DateTime)

Escribe una cookie asociada a la solicitud actual que tiene el valor, la persistencia y la fecha de expiración especificados.Writes a cookie associated with the current request that has the specified value, persistence, and expiration time.

Write(Byte[], String, DateTime)

Escribe una cookie asociada a la solicitud actual que tiene el nombre, el valor y la fecha de expiración especificados.Writes a cookie associated with the current request that has the specified name, value, and expiration time.

Write(Byte[], String, DateTime, HttpContext)

Escribe una cookie asociada a la solicitud especificada que tiene el nombre, el valor y la fecha de expiración especificados.Writes a cookie associated with the specified request that has the specified name, value, and expiration time.

Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

Escribe una cookie asociada a la solicitud especificada que tiene el nombre, el valor, el dominio, la ruta de acceso, la fecha de expiración y la visibilidad especificados.Writes a cookie associated with the specified request that has the specified name, value, domain, path, expiration time, and visibility.

WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

Cuando se reemplaza en una clase derivada, escribe una cookie asociada a la solicitud especificada que tiene el nombre, el valor, el dominio, la ruta de acceso, la fecha de expiración, la persistencia y la visibilidad especificados.When overridden in a derived class, writes a cookie associated with the specified request that has the specified name, value, domain, path, expiration time, persistence and visibility.

Se aplica a

Consulte también: