CookieHandler Class

Definition

Fournit une classe de base abstraite pour lire, écrire et supprimer des cookies de session sur un client 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
Inheritance
CookieHandler
Derived

Examples

L’exemple suivant configure le SAM pour utiliser un gestionnaire de cookies personnalisé de type MyNamespace.MyCustomCookieHandler.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>  

Remarks

Le SessionAuthenticationModule (SAM) utilise une instance de la classe CookieHandler pour lire, écrire et supprimer le cookie ou les cookies qui contiennent les SessionSecurityToken sur le client HTTP.The 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. Le cookie (ou les cookies, dans le cas où le jeton de session est fractionné entre plusieurs cookies) qui contient le jeton de session, est appelé cookie de session.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) est fourni avec un gestionnaire de cookies appelé le gestionnaire de cookies mémorisé en bloc qui est implémenté par la classe ChunkedCookieHandler.Windows Identity Foundation (WIF) ships with a cookie handler called the chunked cookie handler that is implemented by the ChunkedCookieHandler class. Le gestionnaire de cookies segmentés fractionne le jeton de session sur un ou plusieurs cookies en fonction d’une taille de segment spécifiée.The chunked cookie handler splits the session token across one or more cookies according to a specified chunk size. Cela permet de respecter les limitations de taille sur les cookies individuels imposés par de nombreux navigateurs.This is to meet size limitations on individual cookies imposed by many browsers.

Vous pouvez dériver de CookieHandler pour créer votre propre gestionnaire de cookies.You can derive from CookieHandler to create your own cookie handler. Dans ce cas, vous devez substituer les méthodes DeleteCore, ReadCoreet WriteCore pour effectuer le travail réel de suppression, de lecture et d’écriture du cookie de session.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. Ces méthodes lisent généralement le cookie de la collection HttpRequest.Cookies et écrivent ou suppriment des cookies via la collection HttpResponse.Cookies.These methods typically read the cookie from the HttpRequest.Cookies collection and write or delete cookies through the HttpResponse.Cookies collection. L’objet HttpContext par le biais duquel vous pouvez accéder à la demande et à la réponse est fourni en tant que paramètre à chacune de ces méthodes.The HttpContext object through which you can access the request and response is provided as a parameter to each of these methods. En plus des méthodes requises, vous pouvez éventuellement substituer d’autres propriétés de méthodes virtuelles exposées par la classe CookieHandler pour personnaliser le comportement de votre gestionnaire.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.

Plusieurs propriétés sont exposées par la classe CookieHandler qui spécifient le comportement et les propriétés par défaut pour le cookie de session.Several properties are exposed by the CookieHandler class that specify default behavior and properties for the session cookie. Les propriétés Name, Domainet Path fournissent le nom de base pour le cookie, le domaine dans lequel il est valide et le chemin sous lequel il est stocké sur le client.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 propriété HideFromClientScript spécifie si le cookie est accessible aux scripts côté client.The HideFromClientScript property specifies whether the cookie is accessible to client-side scripts. La propriété RequireSsl spécifie si le cookie doit être transmis uniquement via des connexions sécurisées (HTTPs).The RequireSsl property specifies whether the cookie should be transmitted only over secure (HTTPS) connections. Si cette valeur est définie, la propriété PersistentSessionLifetime est utilisée pour définir l’heure d’expiration des sessions persistantes, c’est-à-dire pour les sessions qui restent valides même après la fermeture du navigateur.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. Toutes ces propriétés ont des propriétés équivalentes qui sont généralement définies sur les objets HttpCookie sous-jacents par les méthodes « Core » du gestionnaire.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. Pour plus d’informations, consultez la documentation de chaque propriété.For more information see the documentation for each property.

Le gestionnaire de cookies utilisé par le SAM peut être spécifié dans la configuration par le biais de l’élément <cookieHandler> .The cookie handler that is used by the SAM can be specified in configuration through the <cookieHandler> element. Le gestionnaire de cookies défini par cet élément peut être modifié dans un délégué d’événement pour l’événement FederatedAuthentication.FederationConfigurationCreated ou il peut être défini ou accessible directement par le biais de la propriété SessionAuthenticationModule.CookieHandler.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.

Constructors

CookieHandler()

Appelée à partir des constructeurs des classes dérivées pour initialiser la classe CookieHandler.Called from constructors in derived classes to initialize the CookieHandler class.

Properties

Domain

Obtient ou définit le domaine utilisé pour les cookies.Gets or sets the domain used for cookies.

HideFromClientScript

Obtient ou définit une valeur qui indique si le cookie doit être masqué du script client.Gets or sets a value that indicates whether the cookie should be hidden from client script.

Name

Obtient ou définit le nom de base pour les cookies écrits par le gestionnaire.Gets or sets the base name for cookies written by the handler.

Path

Obtient ou définit le chemin d'accès virtuel pour les cookies écrit par le gestionnaire.Gets or sets the virtual path for cookies written by the handler.

PersistentSessionLifetime

Durée de vie des sessions persistantes.The lifetime of persistent sessions. Si la valeur est zéro, les sessions transitoires sont toujours utilisées.If zero, transient sessions are always used.

RequireSsl

Obtient ou définit une valeur qui spécifie si le cookie doit être utilisé uniquement avec SSL.Gets or sets a value that specifies whether the cookie should be used only with SSL.

Methods

Delete()

Supprime le cookie associé à la demande actuelle avec le nom, le champ et le chemin d'accès par défaut.Deletes the cookie associated with the current request that has the default name, domain, and path.

Delete(HttpContext)

Supprime le cookie associé à la demande actuelle avec le nom, le champ et le chemin d'accès par défaut.Deletes the cookie associated with the current request that has the default name, domain, and path.

Delete(String)

Supprime le cookie associé à la demande actuelle avec le nom spécifié, le champ et le chemin d'accès par défaut.Deletes the cookie associated with the current request that has the specified name and the default domain and path.

Delete(String, HttpContext)

Supprime le cookie associé à la demande spécifiée avec le nom spécifié, le champ et le chemin d'accès par défaut.Deletes the cookie associated with the specified request that has the specified name and the default domain and path.

Delete(String, String, String, HttpContext)

Supprime le cookie associé à la demande spécifiée avec le nom, le champ et le chemin d'accès spécifiés.Deletes the cookie associated with the specified request that has the specified name, path, and domain.

DeleteCore(String, String, String, HttpContext)

En cas de substitution dans une classe dérivée, supprime le cookie associé à la demande spécifiée qui a le nom, le domaine et le chemin d'accès spécifiés.When overridden in a derived class, deletes the cookie associated with the specified request that has the specified name, domain, and path.

Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
MatchCookiePath(Uri, Uri)

Si le domaine cible est dans le domaine du cookie et si le chemin d'accès cible se trouve dans le chemin d'accès du cookie, respecte la casse de la partie du chemin d'accès du 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()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
Read()

Lit le cookie associé à la demande actuelle avec le nom par défaut.Reads the cookie associated with the current request that has the default name.

Read(HttpContext)

Lit le cookie associé à la demande actuelle avec le nom, le domaine et le chemin d'accès par défaut.Reads the cookie associated with the current request that has the default name, domain, and path.

Read(String)

Lit le cookie associé à la demande actuelle avec le nom spécifié.Reads the cookie associated with the current request that has the specified name.

Read(String, HttpContext)

Lit le cookie associé à la demande spécifiée avec le nom spécifié et le domaine et chemin d'accès par défaut.Reads the cookie associated with the specified request that has the specified name and the default domain and path.

ReadCore(String, HttpContext)

En cas de substitution dans une classe dérivée, lit le cookie portant le nom spécifié et étant associé à la demande spécifiée.When overridden in a derived class, reads the cookie that has the specified name and that is associated with the specified request.

ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)
Write(Byte[], Boolean, DateTime)

Écrit un cookie associé à la demande actuelle portant la valeur, la persistance et le délai d'expiration spécifiés.Writes a cookie associated with the current request that has the specified value, persistence, and expiration time.

Write(Byte[], String, DateTime)

Écrit un cookie associé à la demande actuelle portant le nom, la valeur et le délai d'expiration spécifiés.Writes a cookie associated with the current request that has the specified name, value, and expiration time.

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

Écrit un cookie associé à la demande spécifiée portant le nom, la valeur et le délai d'expiration spécifiés.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)

Écrit un cookie associé à la demande spécifiée portant le nom, la valeur, le domaine, le chemin d'accès, le délai d'expiration et la visibilité spécifiés.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)

En cas de substitution dans une classe dérivée, écrit un cookie associé à la demande spécifiée portant le nom, la valeur, le domaine, le chemin d'accès, le délai d'expiration, la persistance et la visibilité spécifiés.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.

Applies to

See also