OpenJDK 27 · java.net.CookieStore · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	add(URI the uri this cookie associated with. if `null`, this cookie will not be associated with an URI uri, HttpCookie the cookie to store cookie) Adds one HTTP cookie to the store.
public List<HttpCookie>	Returns: an immutable list of HttpCookie, return empty list if no cookies match the given URI get(URI the uri associated with the cookies to be returned uri) Retrieve cookies associated with given URI, or whose domain matches the given URI.
public List<HttpCookie>	Returns: an immutable list of http cookies; return empty list if there's no http cookie in store getCookies() Get all not-expired cookies in cookie store.
public List<URI>	Returns: an immutable list of URIs; return empty list if no cookie in this cookie store is associated with an URI getURIs() Get all URIs which identify the cookies in this cookie store.
public boolean	Returns: `true` if this store contained the specified cookie remove(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. uri, HttpCookie the cookie to remove cookie) Remove a cookie from store.
public boolean	Returns: `true` if this store changed as a result of the call removeAll() Remove all cookies in this cookie store.

Method Detail

add back to summary

public void add(URI uri, HttpCookie cookie)

Adds one HTTP cookie to the store. This is called for every incoming HTTP response.

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 specified, 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.

Parameters

uri:URI: the uri this cookie associated with. if null, this cookie will not be associated with an URI
cookie:HttpCookie: the cookie to store

Exceptions

NullPointerException:: if cookie is null

See Also

get

get back to summary

get	back to summary
public List<HttpCookie> get(URI uri) Retrieve cookies associated with given URI, or whose domain matches the given URI. Only cookies that have not expired are returned. This is called for every outgoing HTTP request. Parameters uri:URI the uri associated with the cookies to be returned Returns:List<HttpCookie> an immutable list of HttpCookie, return empty list if no cookies match the given URI Exceptions NullPointerException: if `uri` is `null` See Also `add`

public List<HttpCookie> get(URI uri)

Retrieve cookies associated with given URI, or whose domain matches the given URI. Only cookies that have not expired are returned. This is called for every outgoing HTTP request.

Parameters

uri:URI: the uri associated with the cookies to be returned

Returns:List<HttpCookie>

an immutable list of HttpCookie, return empty list if no cookies match the given URI

Exceptions

NullPointerException:: if uri is null

See Also

add

getCookies

back to summary

public List<HttpCookie> getCookies()

Get all not-expired cookies in cookie store.

Returns:List<HttpCookie>: an immutable list of http cookies; return empty list if there's no http cookie in store

getURIs	back to summary
public List<URI> getURIs() Get all URIs which identify the cookies in this cookie store. Returns:List<URI> an immutable list of URIs; return empty list if no cookie in this cookie store is associated with an URI

getURIs

back to summary

public List<URI> getURIs()

Get all URIs which identify the cookies in this cookie store.

Returns:List<URI>: an immutable list of URIs; return empty list if no cookie in this cookie store is associated with an URI

remove back to summary

public boolean remove(URI uri, HttpCookie cookie)

Remove a cookie from store.

Parameters

uri: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:HttpCookie: the cookie to remove

Returns:boolean

true if this store contained the specified cookie

Exceptions

NullPointerException:: if cookie is null

removeAll back to summary

removeAll	back to summary
public boolean removeAll() Remove all cookies in this cookie store. Returns:boolean `true` if this store changed as a result of the call

public boolean removeAll()

Remove all cookies in this cookie store.

Returns:boolean: true if this store changed as a result of the call

public Interface CookieStore

Method Summary

Method Detail