- java.lang.Object
-
- java.net.CookieHandler
-
- java.net.CookieManager
-
public class CookieManager extends CookieHandler
CookieManager provides a concrete implementation ofCookieHandler
, which separates the storage of cookies from the policy surrounding accepting and rejecting cookies. A CookieManager is initialized with aCookieStore
which manages storage, and aCookiePolicy
object, which makes policy decisions on cookie acceptance/rejection.The HTTP cookie management in java.net package looks like:
use CookieHandler <------- HttpURLConnection ^ | impl | use CookieManager -------> CookiePolicy | use |--------> HttpCookie | ^ | | use | use | |--------> CookieStore ^ | impl | Internal in-memory implementation
- CookieHandler is at the core of cookie management. User can call CookieHandler.setDefault to set a concrete CookieHanlder implementation to be used.
- CookiePolicy.shouldAccept will be called by CookieManager.put to see whether or not one cookie should be accepted and put into cookie store. User can use any of three pre-defined CookiePolicy, namely ACCEPT_ALL, ACCEPT_NONE and ACCEPT_ORIGINAL_SERVER, or user can define his own CookiePolicy implementation and tell CookieManager to use it.
- CookieStore is the place where any accepted HTTP cookie is stored in. If not specified when created, a CookieManager instance will use an internal in-memory implementation. Or user can implements one and tell CookieManager to use it.
- Currently, only CookieStore.add(URI, HttpCookie) and CookieStore.get(URI) are used by CookieManager. Others are for completeness and might be needed by a more sophisticated CookieStore implementation, e.g. a NetscapeCookieSotre.
There're various ways user can hook up his own HTTP cookie management behavior, e.g.
- Use CookieHandler.setDefault to set a brand new
CookieHandler
implementation - Let CookieManager be the default
CookieHandler
implementation, but implement user's ownCookieStore
andCookiePolicy
and tell default CookieManager to use them:// this should be done at the beginning of an HTTP session CookieHandler.setDefault(new CookieManager(new MyCookieStore(), new MyCookiePolicy()));
- Let CookieManager be the default
CookieHandler
implementation, but use customizedCookiePolicy
:// this should be done at the beginning of an HTTP session CookieHandler.setDefault(new CookieManager()); // this can be done at any point of an HTTP session ((CookieManager)CookieHandler.getDefault()).setCookiePolicy(new MyCookiePolicy());
The implementation conforms to RFC 2965, section 3.3.
- Since:
- 1.6
- See Also:
CookiePolicy
-
-
Constructor Summary
Constructors Constructor and Description CookieManager()
Create a new cookie manager.CookieManager(CookieStore store, CookiePolicy cookiePolicy)
Create a new cookie manager with specified cookie store and cookie policy.
-
Method Summary
Methods Modifier and Type Method and Description 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.CookieStore
getCookieStore()
To retrieve current cookie store.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.void
setCookiePolicy(CookiePolicy cookiePolicy)
To set the cookie policy of this cookie manager.-
Methods inherited from class java.net.CookieHandler
getDefault, setDefault
-
-
-
-
Constructor Detail
-
CookieManager
public CookieManager()
Create a new cookie manager.This constructor will create new cookie manager with default cookie store and accept policy. The effect is same as CookieManager(null, null).
-
CookieManager
public CookieManager(CookieStore store, CookiePolicy cookiePolicy)
Create a new cookie manager with specified cookie store and cookie policy.- Parameters:
store
- a CookieStore to be used by cookie manager. if null, cookie manager will use a default one, which is an in-memory CookieStore implmentation.cookiePolicy
- a CookiePolicy instance to be used by cookie manager as policy callback. if null, ACCEPT_ORIGINAL_SERVER will be used.
-
-
Method Detail
-
setCookiePolicy
public void setCookiePolicy(CookiePolicy cookiePolicy)
To set the cookie policy of this cookie manager.A instance of CookieManager will have cookie policy ACCEPT_ORIGINAL_SERVER by default. Users always can call this method to set another cookie policy.
- Parameters:
cookiePolicy
- the cookie policy. Can be null, which has no effects on current cookie policy.
-
getCookieStore
public CookieStore getCookieStore()
To retrieve current cookie store.- Returns:
- the cookie store currently used by cookie manager.
-
get
public Map<String,List<String>> get(URI uri, Map<String,List<String>> requestHeaders) throws IOException
Description copied from class:CookieHandler
Gets all the applicable cookies from a cookie cache for the specified uri in the request header.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.
- Specified by:
get
in classCookieHandler
- Parameters:
uri
- aURI
representing the intended use for the cookiesrequestHeaders
- - 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
- Throws:
IOException
- if an I/O error occurs- See Also:
CookieHandler.put(URI, Map)
-
put
public void put(URI uri, Map<String,List<String>> responseHeaders) throws IOException
Description copied from class:CookieHandler
Sets all the applicable cookies, examples are response header fields that are named Set-Cookie2, present in the response headers into a cookie cache.- Specified by:
put
in classCookieHandler
- Parameters:
uri
- aURI
where the cookies come fromresponseHeaders
- 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- See Also:
CookieHandler.get(URI, Map)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
01/11/2024 00:56:12 Cette version de la page est en cache (à la date du 01/11/2024 00:56:12) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/net/cookiemanager.html/.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.