Класс CookieHandler

java.lang.Object

java.net.CookieHandler

Прямые известные подклассы:: CookieManager

public abstract class CookieHandler extends Object

Объект CookieHandler предоставляет механизм обратного вызова для подключения реализации политики управления состоянием HTTP в обработчик протокола HTTP. Механизм управления состоянием HTTP определяет способ создания сеанса с состоянием для HTTP-запросов и ответов.

Системный CookieHandler, который будет использоваться обработчиком потока URL HTTP URL, можно зарегистрировать, выполнив CookieHandler.setDefault(CookieHandler). Текущий зарегистрированный CookieHandler можно получить, вызвав CookieHandler.getDefault(). Для получения дополнительной информации об управлении состоянием HTTP см. RFC 2965: Механизм управления состоянием HTTP

С:: 1.5

Краткое описание конструкторов

Конструктор	Описание
`CookieHandler()`	Конструктор для вызова подклассами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`abstract Map<String,List<String>>`	`get(URI uri, Map<String,List<String>> requestHeaders)`	Получает все применимые cookie из кэша cookie для указанного uri в заголовке запроса.
`static CookieHandler`	`getDefault()`	Получает системный обработчик cookie.
`abstract void`	`put(URI uri, Map<String,List<String>> responseHeaders)`	Задает все применимые cookie, например, поля заголовка ответа с именем Set-Cookie2, присутствующие в заголовках ответа, в кэш cookie.
`static void`	`setDefault(CookieHandler cHandler)`	Устанавливает (или отменяет) системный обработчик cookie.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

CookieHandler

public CookieHandler()

Конструктор для вызова подклассами.

Подробное описание методов

getDefault

public static CookieHandler getDefault()

Получает системный обработчик cookie.

Возвращает:

системный обработчик cookie; Возврат null означает, что системный обработчик cookie в настоящее время не установлен.

Бросает:

SecurityException - Если установлен менеджер безопасности и он отказывается NetPermission("getCookieHandler")

См. также:

setDefault(CookieHandler)

setDefault

public static void setDefault(CookieHandler cHandler)

Устанавливает (или отменяет) системный обработчик cookie. Примечание: нестандартные обработчики протокола http могут игнорировать это значение.

Параметры:

cHandler - Обработчик HTTP cookie или null для отмены установки.

Бросает:

SecurityException - Если установлен менеджер безопасности и он отказывается NetPermission("setCookieHandler")

См. также:

getDefault()

get

public abstract Map<String,List<String>> get(URI uri, Map<String,List<String>> requestHeaders) throws IOException

Получает все применимые cookie из кэша cookie для указанного uri в заголовке запроса.

Передаваемый в качестве аргумента URI определяет предполагаемое использование cookie. В частности, схема должна отражать, будут ли cookie отправлены по протоколу http, https или использоваться в другом контексте, например, в javascript. Часть хоста должна отражать либо пункт назначения cookie, либо их происхождение в случае javascript.

От реализации зависит, как будут учитываться URI и атрибуты cookie и настройки безопасности, чтобы определить, какие из них должны быть возвращены.

Реализаторы протокола HTTP должны убедиться, что этот метод вызывается после добавления всех заголовков запроса, связанных с выбором cookie, и перед отправкой запроса.

Параметры:

uri - a URI, представляющий предполагаемое использование cookie

requestHeaders - - a Map из имен полей заголовка запроса к спискам значений поля, представляющих текущие заголовки запроса

Возвращает:

неизменяемая карта заголовков управления состоянием, с именами полей "Cookie" или "Cookie2" до списка cookie, содержащих информацию о состоянии

Бросает:

IOException - если произошла ошибка ввода-вывода

IllegalArgumentException - если какой-либо из аргументов равен null

См. также:

put(URI, Map)

put

public abstract void put(URI uri, Map<String,List<String>> responseHeaders) throws IOException

Задает все применимые cookie, например, поля заголовка ответа с именем Set-Cookie2, присутствующие в заголовках ответа, в кэш cookie.

Параметры:

uri - a URI, откуда получены cookie

responseHeaders - неизменяемая карта имен полей к спискам значений полей, представляющих возвращенные поля заголовка ответа

Бросает:

IOException - если произошла ошибка ввода-вывода

IllegalArgumentException - если какой-либо из аргументов равен null

См. также:

get(URI, Map)

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/CookieHandler.html