- java.lang.Object
-
- java.net.CookieHandler
-
- Direct Known Subclasses:
- CookieManager
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
- Since:
- 1.5
-
-
Constructor Summary
Constructors Constructor and Description CookieHandler()
-
Method Summary
Methods Modifier and Type Method and Description 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.
-
-
-
Method Detail
-
getDefault
public static 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.
- Throws:
SecurityException
- If a security manager has been installed and it deniesNetPermission
("getCookieHandler")- See Also:
setDefault(CookieHandler)
-
setDefault
public static 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, ornull
to unset.- Throws:
SecurityException
- If a security manager has been installed and it deniesNetPermission
("setCookieHandler")- See Also:
getDefault()
-
get
public abstract Map<String,List<String>> get(URI uri, Map<String,List<String>> requestHeaders) throws IOException
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.
- 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 occursIllegalArgumentException
- if either argument is null- See Also:
put(URI, Map)
-
put
public abstract void put(URI uri, Map<String,List<String>> responseHeaders) throws IOException
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
- 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 occursIllegalArgumentException
- if either argument is null- See Also:
get(URI, Map)
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/net/CookieHandler.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.