Интерфейс CookieStore

public interface CookieStore

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

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

С:
1.6

Методы

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

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

List<HttpCookie> get​(URI uri)

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

List<HttpCookie> getCookies()

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

List<URI> getURIs()

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

boolean remove​(URI uri, HttpCookie cookie)

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

boolean removeAll()

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

Методы

add

void add(URI uri,
         HttpCookie cookie)

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

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

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

Параметры:
uri - uri, с которым связана эта куки. Если null, эта куки не будет связана с URI
cookie - куки для сохранения
Исключения:
NullPointerException - если cookie является null
См. также:
get(java.net.URI)

get

List<HttpCookie> get(URI uri)

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

Параметры:
uri - uri, связанный с куками, которые должны быть возвращены
Возвращает:
неизменяемый список HttpCookie, возвращает пустой список, если нет куки, соответствующей данному URI
Исключения:
NullPointerException - если uri является null
См. также:
add(java.net.URI, java.net.HttpCookie)

getCookies

List<HttpCookie> getCookies()

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

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

getURIs

List<URI> getURIs()

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

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

remove

boolean remove(URI uri,
               HttpCookie cookie)

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

Параметры:
uri - uri, с которым связана эта куки. Если null, куки, которую нужно удалить, не была связана с URI при добавлении; если не null, куки, которую нужно удалить, была связана с заданным URI при добавлении.
cookie - куки для удаления
Возвращает:
true если это хранилище содержало указанную куки
Исключения:
NullPointerException - если cookie является null

removeAll

boolean removeAll()

Удаляет все куки из этого хранилища куки.

Возвращает:
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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/CookieStore.html

Spec-Zone .ru
спецификации, руководства, описания, API