Spec-Zone.ru › OpenJDK 8

Интерфейс CookieStore


public interface CookieStore

Объект CookieStore представляет хранилище для cookie. Может хранить и извлекать cookie.

CookieManager будет вызывать CookieStore.add для сохранения cookie при каждом входящем HTTP-ответе и вызывать CookieStore.get для извлечения cookie при каждом исходящем HTTP-запросе. CookieStore отвечает за удаление экземпляров HttpCookie, срок действия которых истек.

Since:
1.6

Методы

Модификатор и тип Метод и описание
void add(URI uri, HttpCookie cookie)

Добавляет один HTTP-cookie в хранилище.

List<HttpCookie> get(URI uri)

Извлекает cookie, связанные с заданным URI или чья область имени соответствует заданному URI.

List<HttpCookie> getCookies()

Получить все непросроченные cookie в хранилище cookie.

List<URI> getURIs()

Получить все URI, идентифицирующие cookie в этом хранилище cookie.

boolean remove(URI uri, HttpCookie cookie)

Удаляет cookie из хранилища.

boolean removeAll()

Удаляет все cookie в этом хранилище cookie.

Методы

add

void add(URI uri,
         HttpCookie cookie)

Добавляет один HTTP-cookie в хранилище. Это вызывается при каждом входящем HTTP-ответе.

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

Если cookie, соответствующий заданному URI, уже существует, он заменяется новым.

Parameters:
uri - uri, с которым связан этот cookie. Если null, этот cookie не будет связан с URI
cookie - cookie для хранения
Throws:
NullPointerException - если cookie является null.
See Also:
get(java.net.URI)

get

List<HttpCookie> get(URI uri)

Извлекает cookie, связанные с заданным URI или чья область имени соответствует заданному URI. Возвращаются только непросроченные cookie. Это вызывается при каждом исходящем HTTP-запросе.

Parameters:
uri - uri, связанный с возвращаемыми cookie
Returns:
неизменяемый список HttpCookie, возвращает пустой список, если ни один cookie не соответствует заданному URI
Throws:
NullPointerException - если uri является null.
See Also:
add(java.net.URI, java.net.HttpCookie)

getCookies

List<HttpCookie> getCookies()

Получить все непросроченные cookie в хранилище cookie.

Returns:
неизменяемый список http-cookie; возвращает пустой список, если в хранилище нет http-cookie

getURIs

List<URI> getURIs()

Получить все URI, идентифицирующие cookie в этом хранилище cookie.

Returns:
неизменяемый список URI; возвращает пустой список, если ни один cookie в этом хранилище cookie не связан с URI

remove

boolean remove(URI uri,
               HttpCookie cookie)

Удаляет cookie из хранилища.

Parameters:
uri - uri, с которым связан этот cookie. Если null, cookie для удаления не связан с URI при добавлении; если не null, cookie для удаления связан с заданным URI при добавлении.
cookie - cookie для удаления
Returns:
true если это хранилище содержало указанный cookie
Throws:
NullPointerException - если cookie является null.

removeAll

boolean removeAll()

Удаляет все cookie в этом хранилище cookie.

Returns:
true если хранилище изменилось в результате вызова

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API