CookieHandler Classe

Définition

Espace de noms:

System.IdentityModel.Services

Assembly:

System.IdentityModel.Services.dll

Fournit une classe de base abstraite pour la lecture, l’écriture et la suppression de cookies de session sur un client HTTP.

public ref class CookieHandler abstract

public abstract class CookieHandler

type CookieHandler = class

Public MustInherit Class CookieHandler

Héritage

Object

CookieHandler

Dérivé

System.IdentityModel.Services.ChunkedCookieHandler

Exemples

L’exemple suivant configure le SAM pour utiliser un gestionnaire de cookies personnalisé de type MyNamespace.MyCustomCookieHandler.

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

Remarques

Le SessionAuthenticationModule (SAM) utilise une instance de la CookieHandler classe pour lire, écrire et supprimer le cookie ou les cookies qui contiennent le SessionSecurityToken client HTTP. Le cookie (ou cookies, dans le cas où le jeton de session est divisé sur plusieurs cookies) qui contient le jeton de session est appelé cookie de session.

Windows Identity Foundation (WIF) est fourni avec un gestionnaire de cookies appelé gestionnaire de cookies segmenté implémenté par la ChunkedCookieHandler classe. Le gestionnaire de cookies segmenté fractionne le jeton de session sur un ou plusieurs cookies en fonction d’une taille de bloc spécifiée. Il s’agit de répondre aux limitations de taille des cookies individuels imposés par de nombreux navigateurs.

Vous pouvez dériver de la création de CookieHandler votre propre gestionnaire de cookies. Lorsque vous le faites, vous devez remplacer les méthodes et WriteCore les DeleteCoreReadCoreméthodes pour effectuer le travail réel de suppression, de lecture et d’écriture du cookie de session. Ces méthodes lisent généralement le cookie de la HttpRequest.Cookies collection et écrivent ou suppriment des cookies via la HttpResponse.Cookies collection. L’objet HttpContext via lequel vous pouvez accéder à la demande et à la réponse est fourni en tant que paramètre pour chacune de ces méthodes. Outre les méthodes requises, vous pouvez éventuellement remplacer d’autres propriétés de méthodes virtuelles exposées par la CookieHandler classe pour personnaliser le comportement de votre gestionnaire.

Plusieurs propriétés sont exposées par la CookieHandler classe qui spécifient le comportement et les propriétés par défaut pour le cookie de session. Les Namepropriétés et Path les propriétés Domainfournissent le nom de base du cookie, le domaine dans lequel il est valide et le chemin d’accès sous lequel il est stocké sur le client. La HideFromClientScript propriété spécifie si le cookie est accessible aux scripts côté client. La RequireSsl propriété spécifie si le cookie doit être transmis uniquement via des connexions sécurisées (HTTPS). Si elle est définie, la PersistentSessionLifetime propriété 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. Toutes ces propriétés ont des propriétés équivalentes qui sont généralement définies sur l’objet sous-jacent HttpCookie (ou les objets) par les méthodes « core » du gestionnaire. Pour plus d’informations, consultez la documentation de chaque propriété.

Le gestionnaire de cookies utilisé par le SAM peut être spécifié dans la configuration via l’élément <cookieHandler> . 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 via la SessionAuthenticationModule.CookieHandler propriété.

Constructeurs

Nom	Description
CookieHandler()	Appelé à partir de constructeurs dans des classes dérivées pour initialiser la CookieHandler classe.

Propriétés

Nom	Description
Domain	Obtient ou définit le domaine utilisé pour les cookies.
HideFromClientScript	Obtient ou définit une valeur qui indique si le cookie doit être masqué dans le script client.
Name	Obtient ou définit le nom de base des cookies écrits par le gestionnaire.
Path	Obtient ou définit le chemin d’accès virtuel pour les cookies écrits par le gestionnaire.
PersistentSessionLifetime	Durée de vie des sessions persistantes. Si zéro, les sessions temporaires sont toujours utilisées.
RequireSsl	Obtient ou définit une valeur qui spécifie si le cookie doit être utilisé uniquement avec SSL.

Méthodes

Nom	Description
Delete()	Supprime le cookie associé à la requête actuelle qui a le nom, le domaine et le chemin d’accès par défaut.
Delete(HttpContext)	Supprime le cookie associé à la requête actuelle qui a le nom, le domaine et le chemin d’accès par défaut.
Delete(String, HttpContext)	Supprime le cookie associé à la demande spécifiée qui a le nom spécifié et le domaine et le chemin d’accès par défaut.
Delete(String, String, String, HttpContext)	Supprime le cookie associé à la requête spécifiée portant le nom, le chemin d’accès et le domaine spécifiés.
Delete(String)	Supprime le cookie associé à la requête actuelle qui a le nom spécifié et le domaine et le chemin d’accès par défaut.
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 spécifiés.
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
GetHashCode()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
MatchCookiePath(Uri, Uri)	Si le domaine cible se trouve dans le domaine de cookie et que le chemin cible se trouve dans le chemin du cookie, correspond à la casse de la partie du chemin d’accès du cookie.
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
Read()	Lit le cookie associé à la requête actuelle portant le nom par défaut.
Read(HttpContext)	Lit le cookie associé à la requête actuelle qui a le nom, le domaine et le chemin d’accès par défaut.
Read(String, HttpContext)	Lit le cookie associé à la requête spécifiée qui a le nom spécifié et le domaine et le chemin d’accès par défaut.
Read(String)	Lit le cookie associé à la requête actuelle portant le nom spécifié.
ReadCore(String, HttpContext)	En cas de substitution dans une classe dérivée, lit le cookie portant le nom spécifié et associé à la requête spécifiée.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)
Write(Byte[], Boolean, DateTime)	Écrit un cookie associé à la requête actuelle qui a la valeur, la persistance et l’heure d’expiration spécifiées.
Write(Byte[], String, DateTime, HttpContext)	Écrit un cookie associé à la demande spécifiée qui a le nom, la valeur et l’heure d’expiration spécifiés.
Write(Byte[], String, DateTime)	Écrit un cookie associé à la requête actuelle qui a le nom, la valeur et l’heure d’expiration spécifiés.
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	Écrit un cookie associé à la requête spécifiée qui a le nom, la valeur, le domaine, le chemin d’accès, l’heure d’expiration et la visibilité spécifiés.
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 qui a le nom, la valeur, le domaine, le chemin, l’heure d’expiration, la persistance et la visibilité spécifiés.

Voir aussi

• ChunkedCookieHandler
• <cookieHandler>