org.apache.commons.httpclient.cookie

Class CookiePolicy


public abstract class CookiePolicy
extends java.lang.Object

Cookie management policy class. The cookie policy provides corresponding cookie management interfrace for a given type or version of cookie.

RFC 2109 specification is used per default. Other supported specification can be chosen when appropriate or set default when desired

The following specifications are provided:

Authors:
Oleg Kalnichevski
Mike Bowler
Since:
2.0

Field Summary

static String
BROWSER_COMPATIBILITY
The policy that provides high degree of compatibilty with common cookie management of popular HTTP agents.
static int
COMPATIBILITY
Deprecated. Use BROWSER_COMPATIBILITY
static String
DEFAULT
The default cookie policy.
static String
IGNORE_COOKIES
The policy that ignores cookies.
protected static Log
LOG
Log object.
static String
NETSCAPE
The Netscape cookie draft compliant policy.
static int
NETSCAPE_DRAFT
Deprecated. Use NETSCAPE
static int
RFC2109
Deprecated. Use RFC_2109
static String
RFC_2109
The RFC 2109 compliant policy.

Method Summary

static CookieSpec
getCompatibilitySpec()
Deprecated. Use getCookieSpec(String)
static CookieSpec
getCookieSpec(String id)
Gets the cookie specification with the given ID.
static int
getDefaultPolicy()
Deprecated. Use getDefaultSpec()
static CookieSpec
getDefaultSpec()
Returns cookie specification registered as DEFAULT.
static CookieSpec
getSpecByPolicy(int policy)
Deprecated. Use getCookieSpec(String)
static CookieSpec
getSpecByVersion(int ver)
Deprecated. Use getCookieSpec(String)
static void
registerCookieSpec(String id, Class clazz)
Registers a new cookie specification with the given identifier.
static void
setDefaultPolicy(int policy)
Deprecated. Use registerCookieSpec(String,Class)
static void
unregisterCookieSpec(String id)
Unregisters the cookie specification with the given ID.

Field Details

BROWSER_COMPATIBILITY

public static final String BROWSER_COMPATIBILITY
The policy that provides high degree of compatibilty with common cookie management of popular HTTP agents.
Since:
3.0

COMPATIBILITY

public static final int COMPATIBILITY

Deprecated. Use BROWSER_COMPATIBILITY

The COMPATIBILITY policy provides high compatibilty with common cookie management of popular HTTP agents.
Field Value:
0

DEFAULT

public static final String DEFAULT
The default cookie policy.
Since:
3.0

IGNORE_COOKIES

public static final String IGNORE_COOKIES
The policy that ignores cookies.
Since:
3.0

LOG

protected static final Log LOG
Log object.

NETSCAPE

public static final String NETSCAPE
The Netscape cookie draft compliant policy.
Since:
3.0

NETSCAPE_DRAFT

public static final int NETSCAPE_DRAFT

Deprecated. Use NETSCAPE

The NETSCAPE_DRAFT Netscape draft compliant policy.
Field Value:
1

RFC2109

public static final int RFC2109

Deprecated. Use RFC_2109

The RFC2109 RFC 2109 compliant policy.
Field Value:
2

RFC_2109

public static final String RFC_2109
The RFC 2109 compliant policy.
Since:
3.0

Method Details

getCompatibilitySpec

public static CookieSpec getCompatibilitySpec()

Deprecated. Use getCookieSpec(String)

Returns:
cookie specification interface that provides high compatibilty with common cookie management of popular HTTP agents

getCookieSpec

public static CookieSpec getCookieSpec(String id)
            throws IllegalStateException
Gets the cookie specification with the given ID.
Parameters:
id - the cookie specification ID
Since:
3.0

getDefaultPolicy

public static int getDefaultPolicy()

Deprecated. Use getDefaultSpec()

Returns:
default cookie policy

getDefaultSpec

public static CookieSpec getDefaultSpec()
Returns cookie specification registered as DEFAULT. If no default cookie specification has been registered, RFC2109 specification is returned.
Returns:
default cookie specification
See Also:
DEFAULT

getSpecByPolicy

public static CookieSpec getSpecByPolicy(int policy)

Deprecated. Use getCookieSpec(String)

Parameters:
policy - cookie policy to get the CookieSpec for
Returns:
cookie specification interface for the given policy

getSpecByVersion

public static CookieSpec getSpecByVersion(int ver)

Deprecated. Use getCookieSpec(String)

Gets the CookieSpec for a particular cookie version.

Supported versions:

  • version 0 corresponds to the Netscape draft
  • version 1 corresponds to the RFC 2109
  • Any other cookie value coresponds to the default spec
    Parameters:
    ver - the cookie version to get the spec for
    Returns:
    cookie specification interface intended for processing cookies with the given version

    registerCookieSpec

    public static void registerCookieSpec(String id,
                                          Class clazz)
    Registers a new cookie specification with the given identifier. If a specification with the given ID already exists it will be overridden. This ID is the same one used to retrieve the cookie specification from getCookieSpec(String).
    Parameters:
    id - the identifier for this specification
    clazz - the cookie specification class to register
    Since:
    3.0

    setDefaultPolicy

    public static void setDefaultPolicy(int policy)

    Deprecated. Use registerCookieSpec(String,Class)

    Parameters:
    policy - new default cookie policy
    See Also:
    DEFAULT

    unregisterCookieSpec

    public static void unregisterCookieSpec(String id)
    Parameters:
    id - the ID of the cookie specification to unregister
    Since:
    3.0

    Copyright (c) 1999-2005 - Apache Software Foundation