|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.net.CookieHandler
public abstract class CookieHandler
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
| Constructor Summary | |
|---|---|
CookieHandler()
|
|
| Method Summary | |
|---|---|
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. |
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. |
static void |
setDefault(CookieHandler cHandler)
Sets (or unsets) the system-wide cookie handler. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public CookieHandler()
| Method Detail |
|---|
public static CookieHandler getDefault()
SecurityException - If a security manager has been installed and it denies
NetPermission("getCookieHandler")setDefault(CookieHandler)public static void setDefault(CookieHandler cHandler)
cHandler - The HTTP cookie handler, or
null to unset.
SecurityException - If a security manager has been installed and it denies
NetPermission("setCookieHandler")getDefault()
public abstract Map<String,List<String>> get(URI uri,
Map<String,List<String>> requestHeaders)
throws IOException
uri - a URI to send cookies to in a requestrequestHeaders - - a Map from request header
field names to lists of field values representing
the current request headers
IOException - if an I/O error occurs
IllegalArgumentException - if either argument is nullput(URI, Map)
public abstract void put(URI uri,
Map<String,List<String>> responseHeaders)
throws IOException
uri - a URI where the cookies come fromresponseHeaders - an immutable map from field names to
lists of field values representing the response
header fields returned
IOException - if an I/O error occurs
IllegalArgumentException - if either argument is nullget(URI, Map)
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.