CookieHandler Klasa

Definicja

Przestrzeń nazw:

System.IdentityModel.Services

Zestaw:

System.IdentityModel.Services.dll

Udostępnia abstrakcyjną klasę bazową do odczytywania, zapisywania i usuwania plików cookie sesji na kliencie HTTP.

public ref class CookieHandler abstract

public abstract class CookieHandler

type CookieHandler = class

Public MustInherit Class CookieHandler

Dziedziczenie

Object

CookieHandler

Pochodne

System.IdentityModel.Services.ChunkedCookieHandler

Przykłady

Poniższy przykład umożliwia skonfigurowanie protokołu SAM do używania niestandardowej procedury obsługi plików cookie typu MyNamespace.MyCustomCookieHandler.

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

Uwagi

( SessionAuthenticationModule SAM) używa wystąpienia CookieHandler klasy do odczytywania, zapisywania i usuwania plików cookie lub plików cookie, które zawierają SessionSecurityToken element na kliencie HTTP. Plik cookie (lub pliki cookie, w przypadku gdy token sesji jest podzielony na kilka plików cookie), który zawiera token sesji, jest znany jako plik cookie sesji.

Program windows Identity Foundation (WIF) jest dostarczany z procedurą obsługi plików cookie nazywaną fragmentowaną procedurą obsługi plików cookie implementowaną przez klasę ChunkedCookieHandler . Fragmentowana procedura obsługi plików cookie dzieli token sesji na co najmniej jeden plik cookie zgodnie z określonym rozmiarem fragmentu. Ma to na celu spełnienie ograniczeń rozmiaru poszczególnych plików cookie narzuconych przez wiele przeglądarek.

Możesz utworzyć własną procedurę obsługi plików cookie.CookieHandler W tym celu należy zastąpić DeleteCoremetody , i WriteCore , ReadCoreaby wykonać rzeczywistą pracę usuwania, odczytywania i zapisywania pliku cookie sesji. Te metody zwykle odczytują plik cookie z HttpRequest.Cookies kolekcji i zapisują lub usuwają pliki cookie za pośrednictwem HttpResponse.Cookies kolekcji. Obiekt HttpContext , za pomocą którego można uzyskać dostęp do żądania i odpowiedzi, jest udostępniany jako parametr dla każdej z tych metod. Oprócz wymaganych metod można opcjonalnie zastąpić inne właściwości metod wirtualnych uwidocznionych przez klasę CookieHandler , aby dostosować zachowanie programu obsługi.

Kilka właściwości jest uwidacznianych przez klasę CookieHandler , która określa domyślne zachowanie i właściwości pliku cookie sesji. Właściwości Name, Domaini Path podaj podstawową nazwę pliku cookie, domenę, w której jest prawidłowa, oraz ścieżkę, w której jest przechowywany na kliencie. Właściwość HideFromClientScript określa, czy plik cookie jest dostępny dla skryptów po stronie klienta. Właściwość RequireSsl określa, czy plik cookie ma być przesyłany tylko za pośrednictwem bezpiecznych połączeń (HTTPS). W przypadku ustawienia PersistentSessionLifetime właściwość jest używana do ustawiania czasu wygaśnięcia dla sesji trwałych, czyli dla sesji, które pozostają prawidłowe nawet po zamknięciu przeglądarki. Wszystkie te właściwości mają równoważne właściwości, które są zwykle ustawiane na obiekcie bazowym HttpCookie (lub obiektach) za pomocą metod "rdzenia" programu obsługi. Aby uzyskać więcej informacji, zobacz dokumentację każdej właściwości.

Program obsługi plików cookie używany przez sam można określić w konfiguracji za pomocą <elementu cookieHandler> . Program obsługi plików cookie ustawiony przez ten element można zmodyfikować w delegatze zdarzeń dla FederatedAuthentication.FederationConfigurationCreated zdarzenia lub można go ustawić lub uzyskać do niego dostęp bezpośrednio za pośrednictwem SessionAuthenticationModule.CookieHandler właściwości .

Konstruktory

Nazwa	Opis
CookieHandler()	Wywoływane z konstruktorów w klasach pochodnych w celu zainicjowania CookieHandler klasy.

Właściwości

Nazwa	Opis
Domain	Pobiera lub ustawia domenę używaną do plików cookie.
HideFromClientScript	Pobiera lub ustawia wartość wskazującą, czy plik cookie powinien być ukryty przed skryptem klienta.
Name	Pobiera lub ustawia podstawową nazwę plików cookie zapisanych przez program obsługi.
Path	Pobiera lub ustawia ścieżkę wirtualną dla plików cookie zapisanych przez program obsługi.
PersistentSessionLifetime	Okres istnienia sesji trwałych. Jeśli zero, sesje przejściowe są zawsze używane.
RequireSsl	Pobiera lub ustawia wartość określającą, czy plik cookie ma być używany tylko z protokołem SSL.

Metody

Nazwa	Opis
Delete()	Usuwa plik cookie skojarzony z bieżącym żądaniem, które ma domyślną nazwę, domenę i ścieżkę.
Delete(HttpContext)	Usuwa plik cookie skojarzony z bieżącym żądaniem, które ma domyślną nazwę, domenę i ścieżkę.
Delete(String, HttpContext)	Usuwa plik cookie skojarzony z określonym żądaniem, które ma określoną nazwę oraz domyślną domenę i ścieżkę.
Delete(String, String, String, HttpContext)	Usuwa plik cookie skojarzony z określonym żądaniem, które ma określoną nazwę, ścieżkę i domenę.
Delete(String)	Usuwa plik cookie skojarzony z bieżącym żądaniem, które ma określoną nazwę oraz domyślną domenę i ścieżkę.
DeleteCore(String, String, String, HttpContext)	Po zastąpieniu w klasie pochodnej usuwa plik cookie skojarzony z określonym żądaniem, które ma określoną nazwę, domenę i ścieżkę.
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
MatchCookiePath(Uri, Uri)	Jeśli domena docelowa znajduje się w domenie plików cookie, a ścieżka docelowa znajduje się w ścieżce pliku cookie, dopasuj wielkość liter części ścieżki pliku cookie.
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
Read()	Odczytuje plik cookie skojarzony z bieżącym żądaniem o nazwie domyślnej.
Read(HttpContext)	Odczytuje plik cookie skojarzony z bieżącym żądaniem, które ma domyślną nazwę, domenę i ścieżkę.
Read(String, HttpContext)	Odczytuje plik cookie skojarzony z określonym żądaniem, które ma określoną nazwę oraz domyślną domenę i ścieżkę.
Read(String)	Odczytuje plik cookie skojarzony z bieżącym żądaniem, które ma określoną nazwę.
ReadCore(String, HttpContext)	Po zastąpieniu w klasie pochodnej odczytuje plik cookie, który ma określoną nazwę i który jest skojarzony z określonym żądaniem.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
Write(Byte[], Boolean, DateTime)	Zapisuje plik cookie skojarzony z bieżącym żądaniem, które ma określoną wartość, trwałość i czas wygaśnięcia.
Write(Byte[], String, DateTime, HttpContext)	Zapisuje plik cookie skojarzony z określonym żądaniem, które ma określoną nazwę, wartość i czas wygaśnięcia.
Write(Byte[], String, DateTime)	Zapisuje plik cookie skojarzony z bieżącym żądaniem, które ma określoną nazwę, wartość i czas wygaśnięcia.
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	Zapisuje plik cookie skojarzony z określonym żądaniem, który ma określoną nazwę, wartość, domenę, ścieżkę, czas wygaśnięcia i widoczność.
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	Po zastąpieniu w klasie pochodnej zapisuje plik cookie skojarzony z określonym żądaniem, które ma określoną nazwę, wartość, domenę, ścieżkę, czas wygaśnięcia, trwałość i widoczność.

Zobacz też

• ChunkedCookieHandler
• <Cookiehandler>