CookieHandler Třída

Definice

Obor názvů:

System.IdentityModel.Services

Sestavení:

System.IdentityModel.Services.dll

Poskytuje abstraktní základní třídu pro čtení, zápis a odstraňování souborů cookie relace na klientovi HTTP.

public ref class CookieHandler abstract

public abstract class CookieHandler

type CookieHandler = class

Public MustInherit Class CookieHandler

Dědičnost

Object

CookieHandler

Odvozené

System.IdentityModel.Services.ChunkedCookieHandler

Příklady

Následující příklad nakonfiguruje SAM tak, aby používal vlastní obslužnou rutinu souboru cookie typu MyNamespace.MyCustomCookieHandler.

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

Poznámky

Sam SessionAuthenticationModule používá instanci CookieHandler třídy ke čtení, zápisu a odstraňování souborů cookie nebo souborů cookie, které obsahují SessionSecurityToken na klientovi HTTP. Soubor cookie (nebo soubory cookie, v případě, že je token relace rozdělen mezi několik souborů cookie), který obsahuje token relace, se označuje jako soubor cookie relace.

Windows Identity Foundation (WIF) se dodává s obslužnou rutinou souboru cookie označovanou jako obslužná rutina souboru cookie blokovaná do bloku, která je implementována ChunkedCookieHandler třídou. Obslužná rutina blokovaného souboru cookie rozdělí token relace mezi jeden nebo více souborů cookie podle zadané velikosti bloku dat. To znamená, že splňuje omezení velikosti jednotlivých souborů cookie uložených mnoha prohlížeči.

Můžete odvodit z CookieHandler vytvoření vlastní obslužné rutiny souborů cookie. Když to uděláte, musíte přepsat DeleteCore, ReadCorea WriteCore metody provádět skutečnou práci odstranění, čtení a zápisu souboru cookie relace. Tyto metody obvykle čtou soubor cookie z HttpRequest.Cookies kolekce a zapisují nebo odstraňují soubory cookie prostřednictvím HttpResponse.Cookies kolekce. Objekt HttpContext , přes který můžete získat přístup k požadavku a odpovědi, je poskytován jako parametr pro každou z těchto metod. Kromě požadovaných metod můžete volitelně přepsat další vlastnosti virtuálních metod vystavených CookieHandler třídou a přizpůsobit chování obslužné rutiny.

Třída, která určuje výchozí chování a vlastnosti souboru cookie relace, je vystaveno CookieHandler několik vlastností. Domain, Namea Path vlastnosti zadejte základní název souboru cookie, doménu, ve které je platná, a cestu, pod kterou je uložena v klientovi. Vlastnost HideFromClientScript určuje, zda je soubor cookie přístupný pro skripty na straně klienta. Vlastnost RequireSsl určuje, zda má být soubor cookie přenášen pouze přes zabezpečená připojení (HTTPS). Pokud je nastavena, PersistentSessionLifetime vlastnost slouží k nastavení doby vypršení platnosti trvalých relací, to znamená pro relace, které zůstávají platné i po zavření prohlížeče. Všechny tyto vlastnosti mají ekvivalentní vlastnosti, které jsou obvykle nastaveny na podkladový HttpCookie objekt (nebo objekty) metodami "core" obslužné rutiny. Další informace najdete v dokumentaci pro každou vlastnost.

Obslužnou rutinu souboru cookie, kterou používá SAM, lze zadat v konfiguraci prostřednictvím elementu< cookieHandler>. Obslužná rutina souboru cookie nastavená tímto prvkem může být změněna v delegátu FederatedAuthentication.FederationConfigurationCreated události události nebo může být nastavena nebo přístup přímo prostřednictvím SessionAuthenticationModule.CookieHandler vlastnosti.

Konstruktory

Name	Description
CookieHandler()	Volána z konstruktorů v odvozených třídách k inicializaci CookieHandler třídy.

Vlastnosti

Name	Description
Domain	Získá nebo nastaví doménu používanou pro soubory cookie.
HideFromClientScript	Získá nebo nastaví hodnotu, která označuje, zda má být soubor cookie skrytý před klientským skriptem.
Name	Získá nebo nastaví základní název pro soubory cookie napsané obslužnou rutinou.
Path	Získá nebo nastaví virtuální cestu pro soubory cookie napsané obslužnou rutinou.
PersistentSessionLifetime	Životnost trvalých relací. Pokud je nula, vždy se použijí přechodné relace.
RequireSsl	Získá nebo nastaví hodnotu, která určuje, zda má být soubor cookie použit pouze s SSL.

Metody

Name	Description
Delete()	Odstraní soubor cookie přidružený k aktuálnímu požadavku, který má výchozí název, doménu a cestu.
Delete(HttpContext)	Odstraní soubor cookie přidružený k aktuálnímu požadavku, který má výchozí název, doménu a cestu.
Delete(String, HttpContext)	Odstraní soubor cookie přidružený k zadanému požadavku, který má zadaný název a výchozí doménu a cestu.
Delete(String, String, String, HttpContext)	Odstraní soubor cookie přidružený k zadanému požadavku, který má zadaný název, cestu a doménu.
Delete(String)	Odstraní soubor cookie přidružený k aktuálnímu požadavku, který má zadaný název a výchozí doménu a cestu.
DeleteCore(String, String, String, HttpContext)	Při přepsání v odvozené třídě odstraní soubor cookie přidružený k zadanému požadavku, který má zadaný název, doménu a cestu.
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MatchCookiePath(Uri, Uri)	Pokud je cílová doména v doméně cookie a cílová cesta je v cestě cookie, odpovídá velikostí a velikostí části cesty k souboru cookie.
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
Read()	Přečte soubor cookie přidružený k aktuálnímu požadavku, který má výchozí název.
Read(HttpContext)	Přečte soubor cookie přidružený k aktuálnímu požadavku, který má výchozí název, doménu a cestu.
Read(String, HttpContext)	Přečte soubor cookie přidružený k zadanému požadavku, který má zadaný název a výchozí doménu a cestu.
Read(String)	Přečte soubor cookie přidružený k aktuálnímu požadavku, který má zadaný název.
ReadCore(String, HttpContext)	Při přepsání v odvozené třídě přečte soubor cookie, který má zadaný název a který je přidružen k zadanému požadavku.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)
Write(Byte[], Boolean, DateTime)	Zapíše soubor cookie přidružený k aktuálnímu požadavku, který má zadanou hodnotu, trvalost a čas vypršení platnosti.
Write(Byte[], String, DateTime, HttpContext)	Zapíše soubor cookie přidružený k zadanému požadavku se zadaným názvem, hodnotou a časem vypršení platnosti.
Write(Byte[], String, DateTime)	Zapíše soubor cookie přidružený k aktuálnímu požadavku, který má zadaný název, hodnotu a čas vypršení platnosti.
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	Zapíše soubor cookie přidružený k zadanému požadavku, který má zadaný název, hodnotu, doménu, cestu, čas vypršení platnosti a viditelnost.
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	Při přepsání v odvozené třídě zapíše soubor cookie přidružený k zadanému požadavku, který má zadaný název, hodnotu, doménu, cestu, čas vypršení platnosti, trvalost a viditelnost.

Viz také

• ChunkedCookieHandler
• <cookieHandler>