CookieHandler Класс

Определение

Пространство имен:: System.IdentityModel.Services

Сборка:: System.IdentityModel.Services.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет абстрактный базовый класс для чтения, записи и удаления файлов cookie сеанса на HTTP-клиенте.

public ref class CookieHandler abstract

public abstract class CookieHandler

type CookieHandler = class

Public MustInherit Class CookieHandler

Наследование: Object
CookieHandler

Производный: System.IdentityModel.Services.ChunkedCookieHandler

Примеры

В следующем примере SAM настраивается для использования пользовательского обработчика файлов cookie типа MyNamespace.MyCustomCookieHandler.

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

В SessionAuthenticationModule SAM используется экземпляр CookieHandler класса для чтения, записи и удаления файлов cookie или файлов cookie, содержащихся SessionSecurityToken в HTTP-клиенте. Файл cookie (или файлы cookie, если маркер сеанса разделен по нескольким файлам cookie), содержащий маркер сеанса, называется файлом cookie сеанса.

Windows Identity Foundation (WIF) поставляется с обработчиком файлов cookie, который называется фрагментированные обработчики файлов cookie, реализованные ChunkedCookieHandler классом. Обработчик файлов cookie с блоками разделяет маркер сеанса по одному или нескольким файлам cookie в соответствии с указанным размером блока. Это необходимо для удовлетворения ограничений размера отдельных файлов cookie, введенных многими браузерами.

Вы можете получить производный от CookieHandler создания собственного обработчика файлов cookie. При этом необходимо переопределить DeleteCore ReadCoreметоды и WriteCore методы для выполнения фактической работы по удалению, чтению и записи файла cookie сеанса. Эти методы обычно считывают файл cookie из HttpRequest.Cookies коллекции и записывают или удаляют файлы cookie через коллекцию HttpResponse.Cookies . Объект HttpContext , с помощью которого можно получить доступ к запросу и ответу, предоставляется в качестве параметра для каждого из этих методов. Помимо обязательных методов, можно дополнительно переопределить другие свойства виртуальных методов, предоставляемые CookieHandler классом, чтобы настроить поведение обработчика.

Несколько свойств предоставляются классом CookieHandler , определяющим поведение и свойства по умолчанию для файла cookie сеанса. DomainСвойства Nameи Path свойства предоставляют базовое имя файла cookie, домен, в котором он действителен, и путь, в котором он хранится на клиенте. Свойство HideFromClientScript указывает, доступен ли файл cookie для клиентских скриптов. Свойство RequireSsl указывает, следует ли передавать файлы cookie только через безопасные подключения (HTTPS). Если задано, PersistentSessionLifetime свойство используется для задания срока действия постоянных сеансов, то есть для сеансов, которые остаются действительными даже после закрытия браузера. Все эти свойства имеют эквивалентные свойства, которые обычно задаются в базовом HttpCookie объекте (или объектах) основными методами обработчика. Дополнительные сведения см. в документации по каждому свойству.

Обработчик файлов cookie, используемый SAM, можно указать в конфигурации с помощью <элемента cookieHandler> . Обработчик файлов cookie, заданный этим элементом, можно изменить в делегате события для FederatedAuthentication.FederationConfigurationCreated события, или его можно задать или получить непосредственно через SessionAuthenticationModule.CookieHandler свойство.

Конструкторы

Имя	Описание
CookieHandler()	Вызывается из конструкторов в производных классах для инициализации CookieHandler класса.

Свойства

Имя	Описание
Domain	Возвращает или задает домен, используемый для файлов cookie.
HideFromClientScript	Возвращает или задает значение, указывающее, должен ли файл cookie быть скрыт от клиентского скрипта.
Name	Возвращает или задает базовое имя файлов cookie, написанных обработчиком.
Path	Возвращает или задает виртуальный путь для файлов cookie, написанных обработчиком.
PersistentSessionLifetime	Время существования постоянных сеансов. Если ноль, то временные сеансы всегда используются.
RequireSsl	Возвращает или задает значение, указывающее, следует ли использовать файл cookie только с SSL.

Методы

Имя	Описание
Delete()	Удаляет файл cookie, связанный с текущим запросом, который имеет имя, домен и путь по умолчанию.
Delete(HttpContext)	Удаляет файл cookie, связанный с текущим запросом, который имеет имя, домен и путь по умолчанию.
Delete(String, HttpContext)	Удаляет файл cookie, связанный с указанным запросом, который имеет указанное имя и домен и путь по умолчанию.
Delete(String, String, String, HttpContext)	Удаляет файл cookie, связанный с указанным запросом, который имеет указанное имя, путь и домен.
Delete(String)	Удаляет файл cookie, связанный с текущим запросом, который имеет указанное имя и домен и путь по умолчанию.
DeleteCore(String, String, String, HttpContext)	При переопределении в производном классе удаляет файл cookie, связанный с указанным запросом, который имеет указанное имя, домен и путь.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MatchCookiePath(Uri, Uri)	Если целевой домен находится в домене cookie, а целевой путь находится в пути к файлу cookie, соответствует регистру части пути cookie.
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
Read()	Считывает файл cookie, связанный с текущим запросом, который имеет имя по умолчанию.
Read(HttpContext)	Считывает файл cookie, связанный с текущим запросом, который имеет имя, домен и путь по умолчанию.
Read(String, HttpContext)	Считывает файл cookie, связанный с указанным запросом, который имеет указанное имя и домен по умолчанию и путь.
Read(String)	Считывает файл cookie, связанный с текущим запросом с указанным именем.
ReadCore(String, HttpContext)	При переопределении в производном классе считывает файл cookie с указанным именем и связан с указанным запросом.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Write(Byte[], Boolean, DateTime)	Записывает файл cookie, связанный с текущим запросом с указанным значением, сохраняемостью и временем окончания срока действия.
Write(Byte[], String, DateTime, HttpContext)	Записывает файл cookie, связанный с указанным запросом с указанным именем, значением и сроком действия.
Write(Byte[], String, DateTime)	Записывает файл cookie, связанный с текущим запросом с указанным именем, значением и временем окончания срока действия.
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	Записывает файл cookie, связанный с указанным запросом, который имеет указанное имя, значение, домен, путь, срок действия и видимость.
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	При переопределении в производном классе записывает файл cookie, связанный с указанным именем, значением, доменом, путем, временем истечения срока действия, сохраняемостью и видимостью.

Применяется к

См. также раздел

Кері байланыс

Бет пайдалы болды ма?

Бөлісу құралы: