depends.org.apache.commons.httpclient.cookie

类 CookiePolicy

java.lang.Object

depends.org.apache.commons.httpclient.cookie.CookiePolicy

public abstract class CookiePolicy
extends java.lang.Object

Cookie management policy class. The cookie policy provides corresponding cookie management interfrace for a given category 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:

• BROWSER_COMPATIBILITY: compatible with the common cookie management practices (even if they are not 100% standards compliant)
• NETSCAPE: Netscape cookie draft compliant
• RFC_2109: RFC2109 compliant (default)
• IGNORE_COOKIES: do not automcatically process cookies

从以下版本开始:

2.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	BROWSER_COMPATIBILITY The policy that provides high degree of compatibilty with common cookie management of popular HTTP agents.
static int	COMPATIBILITY 已过时。 Use BROWSER_COMPATIBILITY
static java.lang.String	DEFAULT The default cookie policy.
static java.lang.String	IGNORE_COOKIES The policy that ignores cookies.
protected static Log	LOG Log object.
static java.lang.String	NETSCAPE The Netscape cookie draft compliant policy.
static int	NETSCAPE_DRAFT 已过时。 Use NETSCAPE
static java.lang.String	RFC_2109 The RFC 2109 compliant policy.
static java.lang.String	RFC_2965 The RFC 2965 compliant policy.
static int	RFC2109 已过时。 Use RFC_2109
static int	RFC2965 已过时。 Use RFC_2965

构造器概要

构造器

构造器和说明
CookiePolicy()

方法概要

方法

限定符和类型	方法和说明
static CookieSpec	getCompatibilitySpec() 已过时。 Use getCookieSpec(String)
static CookieSpec	getCookieSpec(java.lang.String id) Gets the cookie specification with the given ID.
static int	getDefaultPolicy() 已过时。 Use getDefaultSpec()
static CookieSpec	getDefaultSpec() Returns cookie specification registered as DEFAULT.
static java.lang.String[]	getRegisteredCookieSpecs() Obtains the currently registered cookie policy names.
static CookieSpec	getSpecByPolicy(int policy) 已过时。 Use getCookieSpec(String)
static CookieSpec	getSpecByVersion(int ver) 已过时。 Use getCookieSpec(String)
static void	registerCookieSpec(java.lang.String id, java.lang.Class clazz) Registers a new cookie specification with the given identifier.
static void	setDefaultPolicy(int policy) 已过时。 Use registerCookieSpec(String, Class)
static void	unregisterCookieSpec(java.lang.String id) Unregisters the cookie specification with the given ID.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

BROWSER_COMPATIBILITY

public static final java.lang.String BROWSER_COMPATIBILITY

The policy that provides high degree of compatibilty with common cookie management of popular HTTP agents.

从以下版本开始:

3.0

另请参阅:

常量字段值

NETSCAPE

public static final java.lang.String NETSCAPE

The Netscape cookie draft compliant policy.

从以下版本开始:

3.0

另请参阅:

常量字段值

RFC_2109

public static final java.lang.String RFC_2109

The RFC 2109 compliant policy.

从以下版本开始:

3.0

另请参阅:

常量字段值

RFC_2965

public static final java.lang.String RFC_2965

The RFC 2965 compliant policy.

从以下版本开始:

3.0

另请参阅:

常量字段值

IGNORE_COOKIES

public static final java.lang.String IGNORE_COOKIES

The policy that ignores cookies.

从以下版本开始:

3.0

另请参阅:

常量字段值

DEFAULT

public static final java.lang.String DEFAULT

The default cookie policy.

从以下版本开始:

3.0

另请参阅:

常量字段值

COMPATIBILITY

public static final int COMPATIBILITY

已过时。 Use BROWSER_COMPATIBILITY

The COMPATIBILITY policy provides high compatibilty with common cookie management of popular HTTP agents.

另请参阅:

常量字段值

NETSCAPE_DRAFT

public static final int NETSCAPE_DRAFT

已过时。 Use NETSCAPE

The NETSCAPE_DRAFT Netscape draft compliant policy.

另请参阅:

常量字段值

RFC2109

public static final int RFC2109

已过时。 Use RFC_2109

The RFC2109 RFC 2109 compliant policy.

另请参阅:

常量字段值

RFC2965

public static final int RFC2965

已过时。 Use RFC_2965

The RFC2965 RFC 2965 compliant policy.

另请参阅:

常量字段值

LOG

protected static final Log LOG

Log object.

构造器详细资料

CookiePolicy

public CookiePolicy()

方法详细资料

registerCookieSpec

public static void registerCookieSpec(java.lang.String id,
                      java.lang.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).

参数:

id - the identifier for this specification

clazz - the cookie specification class to register

从以下版本开始:

3.0

另请参阅:

getCookieSpec(String)

unregisterCookieSpec

public static void unregisterCookieSpec(java.lang.String id)

Unregisters the cookie specification with the given ID.

参数:

id - the ID of the cookie specification to unregister

从以下版本开始:

3.0

getCookieSpec

public static CookieSpec getCookieSpec(java.lang.String id)
                                throws java.lang.IllegalStateException

Gets the cookie specification with the given ID.

参数:

id - the cookie specification ID

返回:

cookie specification

抛出:

java.lang.IllegalStateException - if a policy with the ID cannot be found

从以下版本开始:

3.0

getDefaultPolicy

public static int getDefaultPolicy()

已过时。 Use getDefaultSpec()

返回:

default cookie policy

另请参阅:

getDefaultSpec()

setDefaultPolicy

public static void setDefaultPolicy(int policy)

已过时。 Use registerCookieSpec(String, Class)

参数:

policy - new default cookie policy

另请参阅:

DEFAULT

getSpecByPolicy

public static CookieSpec getSpecByPolicy(int policy)

已过时。 Use getCookieSpec(String)

参数:

policy - cookie policy to get the CookieSpec for

返回:

cookie specification interface for the given policy

getDefaultSpec

public static CookieSpec getDefaultSpec()

Returns cookie specification registered as DEFAULT. If no default cookie specification has been registered, RFC2109 specification is returned.

返回:

default cookie specification

另请参阅:

DEFAULT

getSpecByVersion

public static CookieSpec getSpecByVersion(int ver)

已过时。 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 extension cookie value coresponds to the default spec

参数:

ver - the cookie version to get the spec for

返回:

cookie specification interface intended for processing cookies with the given version

getCompatibilitySpec

public static CookieSpec getCompatibilitySpec()

已过时。 Use getCookieSpec(String)

返回:

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

getRegisteredCookieSpecs

public static java.lang.String[] getRegisteredCookieSpecs()

Obtains the currently registered cookie policy names. Note that the DEFAULT policy (if present) is likely to be the same as one of the extension policies, but does not have to be.

返回:

array of registered cookie policy names

从以下版本开始:

3.1