Интерфейс CookieStore
public interface CookieStore
CookieManager будет вызывать CookieStore.add для сохранения cookie для каждого входящего HTTP-ответа и вызывать CookieStore.get для извлечения cookie для каждого исходящего HTTP-запроса. CookieStore отвечает за удаление экземпляров HttpCookie, срок действия которых истек.
- С момента:
- 1.6
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
add |
Добавляет один HTTP cookie в хранилище. |
List<HttpCookie> |
get |
Получает cookie, связанные с заданным URI или чьё доменное имя соответствует заданному URI. |
List<HttpCookie> |
getCookies() |
Получает все непросроченные cookie в хранилище cookie. |
List<URI> |
getURIs() |
Получает все URI, которые идентифицируют cookie в этом хранилище cookie. |
boolean |
remove |
Удаляет cookie из хранилища. |
boolean |
removeAll() |
Удаляет все cookie в этом хранилище cookie. |
Подробное описание методов
add
void add(URI uri, HttpCookie cookie)
Cookie для хранения может или не может быть связан с URI. Если он не связан с URI, атрибуты домена и пути cookie укажут, откуда он пришёл. Если он связан с URI, а атрибуты домена и пути не указаны, заданный URI укажет, откуда пришёл этот cookie.
Если cookie, соответствующий данному URI, уже существует, то он заменяется новым.
- Параметры:
-
uri- uri, с которым связан cookie. Еслиnull, этот cookie не будет связан с URI -
cookie- cookie для хранения - Исключения:
-
NullPointerException- еслиcookieявляетсяnull - См. также:
get
List<HttpCookie> get(URI uri)
- Параметры:
-
uri- uri, связанный с возвращаемыми cookie - Возвращает:
- неизменяемый список HttpCookie, возвращает пустой список, если ни один cookie не соответствует заданному URI
- Исключения:
-
NullPointerException- еслиuriявляетсяnull - См. также:
getCookies
List<HttpCookie> getCookies()
- Возвращает:
- неизменяемый список http-cookie; возвращает пустой список, если в хранилище нет http-cookie
getURIs
List<URI> getURIs()
- Возвращает:
- неизменяемый список URI; возвращает пустой список, если ни один cookie в этом хранилище cookie не связан с URI
remove
boolean remove(URI uri, HttpCookie cookie)
- Параметры:
-
uri- uri, с которым связан cookie. Еслиnull, cookie, который нужно удалить, не связан с URI при добавлении; если неnull, cookie, который нужно удалить, связан с заданным URI при добавлении. -
cookie- cookie для удаления - Возвращает:
-
trueесли это хранилище содержало указанный cookie - Исключения:
-
NullPointerException- еслиcookieявляетсяnull
removeAll
boolean removeAll()
- Возвращает:
-
trueесли это хранилище изменилось в результате вызова
© 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/CookieStore.html