Known Direct Subclasses
CookieManager |
CookieManager provides a concrete implementation of CookieHandler ,
which separates the storage of cookies from the policy surrounding accepting
and rejecting cookies. |
|
Class Overview
A CookieHandler object provides a callback mechanism to hook up a
HTTP state management policy implementation into the HTTP protocol
handler. The HTTP state management mechanism specifies a way to
create a stateful session with HTTP requests and responses.
A system-wide CookieHandler that to used by the HTTP protocol
handler can be registered by doing a
CookieHandler.setDefault(CookieHandler). The currently registered
CookieHandler can be retrieved by calling
CookieHandler.getDefault().
For more information on HTTP state management, see RFC 2965: HTTP
State Management Mechanism
Summary
Public Methods |
abstract
Map<String, List<String>>
|
get(URI uri, Map<String, List<String>> requestHeaders)
Gets all the applicable cookies from a cookie cache for the
specified uri in the request header.
|
synchronized
static
CookieHandler
|
getDefault()
Gets the system-wide cookie handler.
|
abstract
void
|
put(URI uri, Map<String, List<String>> responseHeaders)
Sets all the applicable cookies, examples are response header
fields that are named Set-Cookie2, present in the response
headers into a cookie cache.
|
synchronized
static
void
|
setDefault(CookieHandler cHandler)
Sets (or unsets) the system-wide cookie handler.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
Public Constructors
Public Methods
Gets all the applicable cookies from a cookie cache for the
specified uri in the request header.
HTTP protocol implementers should make sure that this method is
called after all request headers related to choosing cookies
are added, and before the request is sent.
Parameters
uri
| a URI to send cookies to in a request |
requestHeaders
| - a Map from request header
field names to lists of field values representing
the current request headers |
Returns
- an immutable map from state management headers, with
field names "Cookie" or "Cookie2" to a list of
cookies containing state information
public
static
synchronized
CookieHandler
getDefault
()
Gets the system-wide cookie handler.
Returns
- the system-wide cookie handler; A null return means
there is no system-wide cookie handler currently set.
public
abstract
void
put
(URI uri, Map<String, List<String>> responseHeaders)
Sets all the applicable cookies, examples are response header
fields that are named Set-Cookie2, present in the response
headers into a cookie cache.
Parameters
uri
| a URI where the cookies come from |
responseHeaders
| an immutable map from field names to
lists of field values representing the response
header fields returned |
public
static
synchronized
void
setDefault
(CookieHandler cHandler)
Sets (or unsets) the system-wide cookie handler.
Note: non-standard http protocol handlers may ignore this setting.
Parameters
cHandler
| The HTTP cookie handler, or
null to unset. |