public interface CookieStore
CookieManager
will call CookieStore.add to save cookies
for every incoming HTTP response, and call CookieStore.get to
retrieve cookie for every outgoing HTTP request. A CookieStore
is responsible for removing HttpCookie instances which have expired.
Modifier and Type | Method and Description |
---|---|
void |
add(URI uri,
HttpCookie cookie)
Adds one HTTP cookie to the store.
|
List<HttpCookie> |
get(URI uri)
Retrieve cookies associated with given URI, or whose domain matches the
given URI.
|
List<HttpCookie> |
getCookies()
Get all not-expired cookies in cookie store.
|
List<URI> |
getURIs()
Get all URIs which identify the cookies in this cookie store.
|
boolean |
remove(URI uri,
HttpCookie cookie)
Remove a cookie from store.
|
boolean |
removeAll()
Remove all cookies in this cookie store.
|
void add(URI uri, HttpCookie cookie)
A cookie to store may or may not be associated with an URI. If it is not associated with an URI, the cookie's domain and path attribute will indicate where it comes from. If it is associated with an URI and its domain and path attribute are not speicifed, given URI will indicate where this cookie comes from.
If a cookie corresponding to the given URI already exists, then it is replaced with the new one.
uri
- the uri this cookie associated with.
if null, this cookie will not be associated
with an URIcookie
- the cookie to storeNullPointerException
- if cookie is nullget(java.net.URI)
List<HttpCookie> get(URI uri)
NullPointerException
- if uri is nulladd(java.net.URI, java.net.HttpCookie)
List<HttpCookie> getCookies()
List<URI> getURIs()
boolean remove(URI uri, HttpCookie cookie)
uri
- the uri this cookie associated with.
if null, the cookie to be removed is not associated
with an URI when added; if not null, the cookie
to be removed is associated with the given URI when added.cookie
- the cookie to removeNullPointerException
- if cookie is nullboolean removeAll()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.