CookieHandler Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Udostępnia abstrakcyjną klasę bazową służącą 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
-
CookieHandler
- Pochodne
Przykłady
Poniższy przykład umożliwia skonfigurowanie protokołu SAM do użycia 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ą element SessionSecurityToken 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 obsługi plików cookie programu Windows Identity Foundation (WIF) jest dostarczany z procedurą obsługi plików cookie, która jest implementowana 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. Jest to spełnienie ograniczeń rozmiaru poszczególnych plików cookie nakładanych przez wiele przeglądarek.
Możesz utworzyć CookieHandler własną procedurę obsługi plików cookie. W tym celu należy zastąpić DeleteCoremetody , ReadCorei WriteCore , aby wykonać rzeczywistą pracę usuwania, odczytywania i zapisywania pliku cookie sesji. Te metody zazwyczaj 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 CookieHandler klasę w celu dostosowania zachowania 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 nazwę podstawową 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 powinien 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 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 "core" programu obsługi. Aby uzyskać więcej informacji, zobacz dokumentację dla 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 delegatu 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
CookieHandler() |
Wywoływane z konstruktorów w klasach pochodnych w celu zainicjowania CookieHandler klasy. |
Właściwości
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 napisanych przez program obsługi. |
Path |
Pobiera lub ustawia ścieżkę wirtualną dla plików cookie napisanych 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
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) |
Usuwa plik cookie skojarzony z bieżącym żądaniem o określonej nazwie i domyślnej domenie i ścieżce. |
Delete(String, HttpContext) |
Usuwa plik cookie skojarzony z określonym żądaniem o określonej nazwie i domyślnej domenie i ścieżce. |
Delete(String, String, String, HttpContext) |
Usuwa plik cookie skojarzony z określonym żądaniem o określonej nazwie, ścieżce i domenie. |
DeleteCore(String, String, String, HttpContext) |
Po przesłonięciu w klasie pochodnej plik cookie skojarzony z określonym żądaniem o określonej nazwie, domenie i ścieżce. |
Equals(Object) |
Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object) |
GetHashCode() |
Służy jako domyślna funkcja skrótu. (Odziedziczone po Object) |
GetType() |
Type Pobiera bieżące wystąpienie. (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 Objectelementu . (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) |
Odczytuje plik cookie skojarzony z bieżącym żądaniem o określonej nazwie. |
Read(String, HttpContext) |
Odczytuje plik cookie skojarzony z określonym żądaniem o określonej nazwie i domyślnej domenie i ścieżce. |
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) |
Zapisuje plik cookie skojarzony z bieżącym żądaniem o określonej nazwie, wartości i czasie wygaśnięcia. |
Write(Byte[], String, DateTime, HttpContext) |
Zapisuje plik cookie skojarzony z określonym żądaniem o określonej nazwie, wartości i czasie wygaśnięcia. |
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) |
Zapisuje plik cookie skojarzony z określonym żądaniem o określonej nazwie, wartości, domenie, ścieżce, czasie wygaśnięcia i widoczności. |
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) |
Po przesłonięciu w klasie pochodnej zapisuje plik cookie skojarzony z określonym żądaniem o określonej nazwie, wartości, domenie, ścieżce, czasie wygaśnięcia, trwałości i widoczności. |