to top

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

Since: API Level 1

public final class

CookieSpecRegistry

extends Object

java.lang.Object
↳	org.apache.http.cookie.CookieSpecRegistry

Class Overview

Cookie specification registry that can be used to obtain the corresponding cookie specification implementation for a given type of type or version of cookie.

Summary

Public Constructors
	CookieSpecRegistry()

Public Methods
synchronized CookieSpec	getCookieSpec(String name) Gets the `cookie specification` with the given name.
synchronized CookieSpec	getCookieSpec(String name, HttpParams params) Gets the `cookie specification` with the given ID.
synchronized List<String>	getSpecNames() Obtains a list containing names of all registered `cookie specs` in their default order.
synchronized void	register(String name, CookieSpecFactory factory) Registers a `CookieSpecFactory` with the given identifier.
synchronized void	setItems(Map<String, CookieSpecFactory> map) Populates the internal collection of registered `cookie specs` with the content of the map passed as a parameter.
synchronized void	unregister(String id) Unregisters the `CookieSpecFactory` with the given ID.

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

Public Constructors

public CookieSpecRegistry ()

Since: API Level 1

Public Methods

public synchronized CookieSpec getCookieSpec (String name)

Since: API Level 1

Gets the cookie specification with the given name.

Parameters

name	the `cookie specification` identifier

Returns

cookie specification

Throws

IllegalStateException	if a policy with the given name cannot be found

public synchronized CookieSpec getCookieSpec (String name, HttpParams params)

Since: API Level 1

Gets the cookie specification with the given ID.

Parameters

name	the `cookie specification` identifier
params	the `HTTP parameters` for the cookie specification.

Returns

cookie specification

Throws

IllegalStateException	if a policy with the given name cannot be found

public synchronized List<String> getSpecNames ()

Since: API Level 1

Obtains a list containing names of all registered cookie specs in their default order. Note that the DEFAULT policy (if present) is likely to be the same as one of the other policies, but does not have to be.

Returns

list of registered cookie spec names

public synchronized void register (String name, CookieSpecFactory factory)

Since: API Level 1

Registers a CookieSpecFactory with the given identifier. If a specification with the given name already exists it will be overridden. This nameis the same one used to retrieve the CookieSpecFactory from getCookieSpec(String).

Parameters

name	the identifier for this specification
factory	the `CookieSpecFactory` class to register

public synchronized void setItems (Map<String, CookieSpecFactory> map)

Since: API Level 1

Populates the internal collection of registered cookie specs with the content of the map passed as a parameter.

Parameters

map	cookie specs

public synchronized void unregister (String id)

Since: API Level 1

Unregisters the CookieSpecFactory with the given ID.

Parameters

id	the identifier of the `cookie specification` to unregister

Results

Interfaces

Classes

Exceptions

CookieSpecRegistry

Class Overview

Summary

Public Constructors

public CookieSpecRegistry ()

Public Methods

public synchronized CookieSpec getCookieSpec (String name)

Parameters

Returns

Throws

public synchronized CookieSpec getCookieSpec (String name, HttpParams params)

Parameters

Returns

Throws

public synchronized List<String> getSpecNames ()

Returns

public synchronized void register (String name, CookieSpecFactory factory)

Parameters

See Also

public synchronized void setItems (Map<String, CookieSpecFactory> map)

Parameters

public synchronized void unregister (String id)

Parameters