BasicCookieStore

Default implementation of CookieStore

Summary

Public Constructors
	BasicCookieStore() Default constructor.

Public Constructors

BasicCookieStore()

Default constructor.

Public Methods
synchronized void	addCookie(Cookie cookie) Adds an `HTTP cookie`, replacing any existing equivalent cookies.
synchronized void	addCookies(Cookie[] cookies) Adds an array of `HTTP cookies`.
synchronized void	clear() Clears all cookies.
synchronized boolean	clearExpired(Date date) Removes all of `cookies` in this HTTP state that have expired by the specified `date`.
synchronized List<Cookie>	getCookies() Returns an immutable array of `cookies` that this HTTP state currently contains.
String	toString() Returns a string containing a concise, human-readable description of this object.

Public Methods

synchronized void

addCookie(Cookie cookie)

Adds an HTTP cookie, replacing any existing equivalent cookies.

synchronized void

addCookies(Cookie[] cookies)

Adds an array of HTTP cookies.

synchronized void

clear()

Clears all cookies.

synchronized boolean

clearExpired(Date date)

Removes all of cookies in this HTTP state that have expired by the specified date.

synchronized List<Cookie>

getCookies()

Returns an immutable array of cookies that this HTTP state currently contains.

String

toString()

Returns a string containing a concise, human-readable description of this object.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.client.CookieStore

Public Methods

public synchronized void addCookie (Cookie cookie)

Since: API Level 1

Adds an HTTP cookie, replacing any existing equivalent cookies. If the given cookie has already expired it will not be added, but existing values will still be removed.

Parameters

cookie	the `cookie` to be added

public synchronized void addCookies (Cookie[] cookies)

Since: API Level 1

Adds an array of HTTP cookies. Cookies are added individually and in the given array order. If any of the given cookies has already expired it will not be added, but existing values will still be removed.

Parameters

cookies	the `cookies` to be added

public synchronized void clear ()

Since: API Level 1

Clears all cookies.

public synchronized boolean clearExpired (Date date)

Since: API Level 1

Removes all of cookies in this HTTP state that have expired by the specified date.

Returns

true if any cookies were purged.

public synchronized List<Cookie> getCookies ()

Since: API Level 1

Returns an immutable array of cookies that this HTTP state currently contains.

Returns

an array of cookies.

public String toString ()

Since: API Level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns

a printable representation of this object.

Results

Classes

Exceptions

Class Overview

Summary

Public Constructors

public BasicCookieStore ()

Public Methods

public synchronized void addCookie (Cookie cookie)

Parameters

See Also

public synchronized void addCookies (Cookie[] cookies)

Parameters

See Also

public synchronized void clear ()

public synchronized boolean clearExpired (Date date)

Returns

See Also

public synchronized List<Cookie> getCookies ()

Returns

public String toString ()

Returns

java.lang.Object
↳	org.apache.http.impl.client.BasicCookieStore