Класс CookieHandler
- java.lang.Object
-
- java.net.CookieHandler
- Прямые известные подклассы:
CookieManager
public abstract class CookieHandler extends Object
Объект CookieHandler предоставляет механизм обратного вызова для подключения реализации политики управления состоянием HTTP в обработчик протокола HTTP. Механизм управления состоянием HTTP определяет способ создания сеанса с состоянием при HTTP-запросах и ответах.
Системный CookieHandler, который будет использоваться обработчиком потоков URL HTTP, может быть зарегистрирован с помощью 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) |
Получает все применимые куки из кэша куки для указанного uri в заголовке запроса. |
static CookieHandler |
getDefault() |
Получает системный обработчик куки. |
abstract void |
put(URI uri,
Map<String,List<String>> responseHeaders) |
Устанавливает все применимые куки, например, поля заголовка ответа с именем Set-Cookie2, присутствующие в заголовках ответа, в кэш куки. |
static void |
setDefault(CookieHandler cHandler) |
Устанавливает (или сбрасывает) системный обработчик куки. |
Методы, объявленные в классе java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Конструкторы
CookieHandler
public CookieHandler()
Методы
getDefault
public static CookieHandler getDefault()
Получает системный обработчик куки.
- Возвращает:
- системный обработчик куки; Возвращаемое значение null означает, что системный обработчик куки в данный момент не установлен.
- Исключения:
-
SecurityException- Если установлен менеджер безопасности и он запрещаетNetPermission("getCookieHandler") - См. также:
setDefault(CookieHandler)
setDefault
public static void setDefault(CookieHandler cHandler)
Устанавливает (или сбрасывает) системный обработчик куки. Примечание: нестандартные обработчики протокола http могут игнорировать эту настройку.
- Параметры:
-
cHandler- Обработчик HTTP-куки илиnullдля сброса. - Исключения:
-
SecurityException- Если установлен менеджер безопасности и он запрещаетNetPermission("setCookieHandler") - См. также:
getDefault()
get
public abstract Map<String,List<String>> get(URI uri,
Map<String,List<String>> requestHeaders)
throws IOException
Получает все применимые куки из кэша куки для указанного uri в заголовке запроса.
Переданный в качестве аргумента URI указывает предполагаемое использование куки. В частности, схема должна отражать, будут ли куки отправлены по протоколу http, https или использоваться в другом контексте, таком как javascript. Часть host должна отражать либо пункт назначения куки, либо их происхождение в случае javascript.
Реализация должна учитывать URI и атрибуты куки и настройки безопасности, чтобы определить, какие из них следует вернуть.
Реализации протокола HTTP должны убедиться, что этот метод вызывается после добавления всех заголовков запроса, относящихся к выбору куки, и перед отправкой запроса.
- Параметры:
-
uri- aURIrepresenting the intended use for the cookies -
requestHeaders- - a Map from request header field names to lists of field values representing the current request headers - Возвращает:
- неизменяемая карта заголовков управления состоянием, с именами полей "Cookie" или "Cookie2" до списка куки, содержащих информацию о состоянии
- Исключения:
-
IOException- если произошла ошибка ввода-вывода -
IllegalArgumentException- если любой из аргументов равен null - См. также:
put(URI, Map)
put
public abstract void put(URI uri,
Map<String,List<String>> responseHeaders)
throws IOException
Устанавливает все применимые куки, например, поля заголовка ответа с именем Set-Cookie2, присутствующие в заголовках ответа, в кэш куки.
- Параметры:
-
uri- aURIwhere the cookies come from -
responseHeaders- an immutable map from field names to lists of field values representing the response header fields returned - Исключения:
-
IOException- если произошла ошибка ввода-вывода -
IllegalArgumentException- если любой из аргументов равен null - См. также:
get(URI, Map)
© 1993, 2020, 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/11/docs/api/java.base/java/net/CookieHandler.html