Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

BestMatchSpec

extends Object
implements CookieSpec

java.lang.Object
↳	org.apache.http.impl.cookie.BestMatchSpec

Class Overview

'Meta' cookie specification that selects a cookie policy depending on the format of the cookie(s)

Summary

Public Constructors
	BestMatchSpec ( String[] datepatterns, boolean oneHeader)
	BestMatchSpec ()

Public Methods
List < Header >	)">formatCookies ( List < Cookie > cookies) Create `"Cookie"` headers for an array of Cookies.
int	getVersion () Returns version of the state management this cookie specification conforms to.
Header	getVersionHeader () Returns a request header identifying what version of the state management specification is understood.
boolean	match ( Cookie cookie, CookieOrigin origin) Determines if a Cookie matches the target location.
List < Cookie >	parse ( Header header, CookieOrigin origin) Parse the `"Set-Cookie"` Header into an array of Cookies.
void	validate ( Cookie cookie, CookieOrigin origin) Validate the cookie according to validation rules defined by the cookie specification.

[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.cookie.CookieSpec

Public Constructors

public BestMatchSpec ( String[] datepatterns, boolean oneHeader)

Added in API level 1

public BestMatchSpec ()

Added in API level 1

Public Methods

)">

public List < Header > formatCookies ( List < Cookie > cookies)

Added in API level 1

Create "Cookie" headers for an array of Cookies.

Parameters

cookies	the Cookies format into a Cookie header

Returns

a Header for the given Cookies.

public int getVersion ()

Added in API level 1

Returns version of the state management this cookie specification conforms to.

Returns

version of the state management specification

public Header getVersionHeader ()

Added in API level 1

Returns a request header identifying what version of the state management specification is understood. May be null if the cookie specification does not support Cookie2 header.

public boolean match ( Cookie cookie, CookieOrigin origin)

Added in API level 1

Determines if a Cookie matches the target location.

Parameters

cookie	the Cookie to be matched
origin	the target to test against

Returns

true if the cookie should be submitted with a request with given attributes, false otherwise.

public List < Cookie > parse ( Header header, CookieOrigin origin)

Added in API level 1

Parse the "Set-Cookie" Header into an array of Cookies.

This method will not perform the validation of the resultant Cookie s

Parameters

header	the `Set-Cookie` received from the server
origin	details of the cookie origin

Returns

an array of Cookie s parsed from the header

Throws

MalformedCookieException

public void validate ( Cookie cookie, CookieOrigin origin)

Added in API level 1

Validate the cookie according to validation rules defined by the cookie specification.

Parameters

cookie	the Cookie to validate
origin	details of the cookie origin

Throws

MalformedCookieException

Results

Classes

Exceptions

BestMatchSpec

Class Overview

Summary

Public Constructors

public BestMatchSpec ( String[] datepatterns, boolean oneHeader)

public BestMatchSpec ()

Public Methods

public List < Header > formatCookies ( List < Cookie > cookies)

Parameters

Returns

public int getVersion ()

Returns

public Header getVersionHeader ()

public boolean match ( Cookie cookie, CookieOrigin origin)

Parameters

Returns

public List < Cookie > parse ( Header header, CookieOrigin origin)

Parameters

Returns

Throws

public void validate ( Cookie cookie, CookieOrigin origin)

Parameters

Throws