Класс CookieManager

public class CookieManager
extends CookieHandler

CookieManager предоставляет конкретную реализацию CookieHandler, которая отделяет хранение файлов cookie от политики, регулирующей принятие и отклонение файлов cookie. CookieManager инициализируется с CookieStore, который управляет хранением, и объектом CookiePolicy, который принимает решения о политике принятия/отклонения файлов cookie.

Управление файлами cookie HTTP в пакете java.net выглядит следующим образом:

use
 CookieHandler <------- HttpURLConnection
       ^
       | impl
       |         use
 CookieManager -------> CookiePolicy
             |   use
             |--------> HttpCookie
             |              ^
             |              | use
             |   use        |
             |--------> CookieStore
                            ^
                            | impl
                            |
                  Internal in-memory implementation

• CookieHandler является основой управления файлами cookie. Пользователь может вызвать CookieHandler.setDefault для установки конкретной реализации CookieHanlder, которая будет использоваться.
• CookiePolicy.shouldAccept будет вызываться CookieManager.put, чтобы определить, следует ли принимать и помещать один файл cookie в хранилище файлов cookie. Пользователь может использовать любые три предопределенные CookiePolicy, а именно ACCEPT_ALL, ACCEPT_NONE и ACCEPT_ORIGINAL_SERVER, или пользователь может определить свою собственную реализацию CookiePolicy и указать CookieManager использовать её.
• CookieStore — это место, где хранится любой принятый HTTP-файл cookie. Если при создании не указано иное, экземпляр CookieManager будет использовать внутреннюю реализацию в оперативной памяти. Или пользователь может реализовать её и указать CookieManager использовать её.
• В настоящее время CookieManager использует только CookieStore.add(URI, HttpCookie) и CookieStore.get(URI). Другие методы предназначены для полноты и могут потребоваться более сложной реализации CookieStore, например, NetscapeCookieSotre.

Существуют различные способы, которыми пользователь может подключить своё поведение управления HTTP-файлами cookie, например:

• Использовать CookieHandler.setDefault для установки новой реализации CookieHandler
• Разрешить CookieManager быть по умолчанию реализацией CookieHandler, но реализовать собственный CookieStore и CookiePolicy и указать CookieManager использовать их:

  // this should be done at the beginning of an HTTP session
  CookieHandler.setDefault(new CookieManager(new MyCookieStore(), new MyCookiePolicy()));

• Разрешить CookieManager быть по умолчанию реализацией CookieHandler, но использовать настраиваемую CookiePolicy:

  // this should be done at the beginning of an HTTP session
  CookieHandler.setDefault(new CookieManager());
  // this can be done at any point of an HTTP session
  ((CookieManager)CookieHandler.getDefault()).setCookiePolicy(new MyCookiePolicy());

Реализация соответствует RFC 2965, раздел 3.3.

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

CookieManager

public CookieManager()

CookieManager

public CookieManager(CookieStore store,
                     CookiePolicy cookiePolicy)

Создать новый менеджер файлов cookie со специфицированным хранилищем файлов cookie и политикой файлов cookie.

Параметры:

store — CookieStore, используемый менеджером файлов cookie. Если null, менеджер файлов cookie будет использовать хранилище файлов cookie по умолчанию, которое является реализацией CookieStore в оперативной памяти.

cookiePolicy — экземпляр CookiePolicy , используемый менеджером файлов cookie в качестве обратного вызова политики. Если null, будет использоваться ACCEPT_ORIGINAL_SERVER.

Методы

setCookiePolicy

public void setCookiePolicy(CookiePolicy cookiePolicy)

Параметры:

cookiePolicy — политика файлов cookie. Может быть null, что не оказывает влияния на текущую политику файлов cookie.

getCookieStore

public CookieStore getCookieStore()

Получить текущее хранилище файлов cookie.

Возвращает:

хранилище файлов cookie, которое в данный момент используется менеджером файлов cookie.

get

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

Описание скопировано из класса: CookieHandler

Указано в:

get в классе CookieHandler

Параметры:

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

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

Возвращает:

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

Выбрасывает:

IOException — если возникает ошибка ввода/вывода

См. также:

CookieHandler.put(URI, Map)

put

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

Описание скопировано из класса: CookieHandler

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

Указано в:

put в классе CookieHandler

Параметры:

uri — URI, откуда поступают файлы cookie

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

Выбрасывает:

IOException — если возникает ошибка ввода/вывода

См. также:

CookieHandler.get(URI, Map)