Skip to content

Most visited

Recently visited

navigation
Added in API level 9

CookieStore

public interface CookieStore

java.net.CookieStore


A CookieStore object represents a storage for cookie. Can store and retrieve cookies.

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.

Summary

Public methods

abstract void add(URI uri, HttpCookie cookie)

Adds one HTTP cookie to the store.

abstract List<HttpCookie> get(URI uri)

Retrieve cookies associated with given URI, or whose domain matches the given URI.

abstract List<HttpCookie> getCookies()

Get all not-expired cookies in cookie store.

abstract List<URI> getURIs()

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

abstract boolean remove(URI uri, HttpCookie cookie)

Remove a cookie from store.

abstract boolean removeAll()

Remove all cookies in this cookie store.

Public methods

add

Added in API level 9
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 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.

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
Throws
NullPointerException if cookie is null

See also:

get

Added in API level 9
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
Returns
List<HttpCookie> an immutable list of HttpCookie, return empty list if no cookies match the given URI
Throws
NullPointerException if uri is null

See also:

getCookies

Added in API level 9
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

Added in API level 9
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

Added in API level 9
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
Throws
NullPointerException if cookie is null

removeAll

Added in API level 9
boolean removeAll ()

Remove all cookies in this cookie store.

Returns
boolean true if this store changed as a result of the call
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.