FileDocCategorySizeDatePackage
CookieHandler.javaAPI DocJava SE 6 API4454Tue Jun 10 00:25:40 BST 2008java.net

CookieHandler

public abstract class CookieHandler extends Object
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

version
1.4, 03/08/09
author
Yingxian Wang
since
1.5

Fields Summary
private static CookieHandler
cookieHandler
The system-wide cookie handler that will apply cookies to the request headers and manage cookies from the response headers.
Constructors Summary
Methods Summary
public abstract java.util.Mapget(java.net.URI uri, java.util.Map requestHeaders)
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.

param
uri a URI to send cookies to in a request
param
requestHeaders - a Map from request header field names to lists of field values representing the current request headers
return
an immutable map from state management headers, with field names "Cookie" or "Cookie2" to a list of cookies containing state information
throws
IOException if an I/O error occurs
throws
IllegalArgumentException if either argument is null
see
#put(URI, Map)

public static synchronized java.net.CookieHandlergetDefault()
Gets the system-wide cookie handler.

return
the system-wide cookie handler; A null return means there is no system-wide cookie handler currently set.
throws
SecurityException If a security manager has been installed and it denies {@link NetPermission}("getCookieHandler")
see
#setDefault(CookieHandler)

	SecurityManager sm = System.getSecurityManager();
 	if (sm != null) {
  	    sm.checkPermission(SecurityConstants.GET_COOKIEHANDLER_PERMISSION);
 	}
	return cookieHandler;
    
public abstract voidput(java.net.URI uri, java.util.Map 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.

param
uri a URI where the cookies come from
param
responseHeaders an immutable map from field names to lists of field values representing the response header fields returned
throws
IOException if an I/O error occurs
throws
IllegalArgumentException if either argument is null
see
#get(URI, Map)

public static synchronized voidsetDefault(java.net.CookieHandler cHandler)
Sets (or unsets) the system-wide cookie handler. Note: non-standard http protocol handlers may ignore this setting.

param
cHandler The HTTP cookie handler, or null to unset.
throws
SecurityException If a security manager has been installed and it denies {@link NetPermission}("setCookieHandler")
see
#getDefault()

	SecurityManager sm = System.getSecurityManager();
 	if (sm != null) {
 	    sm.checkPermission(SecurityConstants.SET_COOKIEHANDLER_PERMISSION);
 	}
	cookieHandler = cHandler;