declare namespace java { namespace net { /** * CookieManager provides a concrete implementation of {@link CookieHandler}, * which separates the storage of cookies from the policy surrounding accepting * and rejecting cookies. A CookieManager is initialized with a {@link CookieStore} * which manages storage, and a {@link CookiePolicy} object, which makes * policy decisions on cookie acceptance/rejection. *
The HTTP cookie management in java.net package looks like: *
**{@code * 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 {@link CookieHandler} implementation *
- Let CookieManager be the default {@link CookieHandler} implementation, * but implement user's own {@link CookieStore} and {@link CookiePolicy} * 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 {@link CookieHandler} implementation, but * use customized {@link CookiePolicy}: *
** // 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. * @see CookiePolicy * @author Edward Wang * @since 1.6 */ // @ts-ignore class CookieManager extends java.net.CookieHandler { /** * Create a new cookie manager. *
This constructor will create new cookie manager with default * cookie store and accept policy. The effect is same as * {@code CookieManager(null, null)}. */ // @ts-ignore constructor() /** * Create a new cookie manager with specified cookie store and cookie policy. * @param store a {#code CookieStore} to be used by cookie manager. * if {@code null}, cookie manager will use a default one, * which is an in-memory CookieStore implementation. * @param cookiePolicy a {#code CookiePolicy} instance * to be used by cookie manager as policy callback. * if {@code null}, ACCEPT_ORIGINAL_SERVER will * be used. */ // @ts-ignore constructor(store: java.net.CookieStore, cookiePolicy: java.net.CookiePolicy) /** * To set the cookie policy of this cookie manager. *
A instance of {@code CookieManager} will have
* cookie policy ACCEPT_ORIGINAL_SERVER by default. Users always
* can call this method to set another cookie policy.
* @param cookiePolicy the cookie policy. Can be {#code null}, which
* has no effects on current cookie policy.
*/
// @ts-ignore
public setCookiePolicy(cookiePolicy: java.net.CookiePolicy): void
/**
* To retrieve current cookie store.
* @return the cookie store currently used by cookie manager.
*/
// @ts-ignore
public getCookieStore(): java.net.CookieStore
// @ts-ignore
public get(uri: java.net.URI, requestHeaders: java.util.Map