CookieManager
public abstract class CookieHandler extends Object
A system-wide CookieHandler to be used by the HTTP URL stream 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 | Description |
---|---|
CookieHandler() |
Constructor for subclasses to call. |
Modifier and Type | Method | Description |
---|---|---|
abstract Map |
get |
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 |
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 |
Sets (or unsets) the system-wide cookie handler. |
public CookieHandler()
public static CookieHandler getDefault()
SecurityException
- If a security manager has been installed and it denies NetPermission
("getCookieHandler")
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")
public abstract Map<String,List<String>> get(URI uri, Map<String,List<String>> requestHeaders) throws IOException
The URI
passed as an argument specifies the intended use for the cookies. In particular the scheme should reflect whether the cookies will be sent over http, https or used in another context like javascript. The host part should reflect either the destination of the cookies or their origin in the case of javascript.
It is up to the implementation to take into account the URI
and the cookies attributes and security settings to determine which ones should be returned.
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.
uri
- a URI
representing the intended use for the cookiesrequestHeaders
- a Map from request header field names to lists of field values representing the current request headersIOException
- if an I/O error occursIllegalArgumentException
- if either argument is nullpublic 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 returnedIOException
- if an I/O error occursIllegalArgumentException
- if either argument is null
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/CookieHandler.html