Java™ Platform
Standard Ed. 6

java.net
Class CookieManager

java.lang.Object
  extended by java.net.CookieHandler
      extended by java.net.CookieManager

public class CookieManager
extends CookieHandler

CookieManager provides a concrete implementation of CookieHandler, which separates the storage of cookies from the policy surrounding accepting and rejecting cookies. A CookieManager is initialized with a CookieStore which manages storage, and a CookiePolicy 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
 

There're various ways user can hook up his own HTTP cookie management behavior, e.g.

The implementation conforms to RFC 2965, section 3.3.

Since:
1.6

Constructor Summary
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
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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. 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 class CookieHandler
Parameters:
uri - a URI to send cookies to in a request
requestHeaders - - 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 class CookieHandler
Parameters:
uri - a URI where the cookies come from
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
See Also:
CookieHandler.get(URI, Map)

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.