com.oaklandsw.http
Class CookiePolicy

java.lang.Object
  extended bycom.oaklandsw.http.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:

Since:
2.0
Author:
Oleg Kalnichevski, Mike Bowler

Field Summary
static java.lang.String BROWSER_COMPATIBILITY
          The policy that provides high degree of compatibility with common cookie management of popular HTTP agents.
static java.lang.String DEFAULT
          The default cookie policy.
static java.lang.String IGNORE_COOKIES
          The policy that ignores cookies.
static java.lang.String NETSCAPE
          The Netscape cookie draft compliant policy.
static java.lang.String RFC_2109
          The RFC 2109 compliant policy.
 
Constructor Summary
CookiePolicy()
           
 
Method Summary
static CookieSpec getCookieSpec(java.lang.String id)
          Gets the cookie specification with the given ID.
static CookieSpec getDefaultSpec()
          Returns cookie specification registered as DEFAULT.
static void registerCookieSpec(java.lang.String id, java.lang.Class clazz)
          Registers a new cookie specification with the given identifier.
static void unregisterCookieSpec(java.lang.String id)
          Unregisters the cookie specification with the given ID.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BROWSER_COMPATIBILITY

public static final java.lang.String BROWSER_COMPATIBILITY
The policy that provides high degree of compatibility with common cookie management of popular HTTP agents.

Since:
3.0
See Also:
Constant Field Values

NETSCAPE

public static final java.lang.String NETSCAPE
The Netscape cookie draft compliant policy.

Since:
3.0
See Also:
Constant Field Values

RFC_2109

public static final java.lang.String RFC_2109
The RFC 2109 compliant policy.

Since:
3.0
See Also:
Constant Field Values

IGNORE_COOKIES

public static final java.lang.String IGNORE_COOKIES
The policy that ignores cookies.

Since:
3.0
See Also:
Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT
The default cookie policy.

Since:
3.0
See Also:
Constant Field Values
Constructor Detail

CookiePolicy

public CookiePolicy()
Method Detail

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).

Parameters:
id - the identifier for this specification
clazz - the cookie specification class to register
Since:
3.0
See Also:
getCookieSpec(String)

unregisterCookieSpec

public static void unregisterCookieSpec(java.lang.String id)
Unregisters the cookie specification with the given ID.

Parameters:
id - the ID of the cookie specification to unregister
Since:
3.0

getCookieSpec

public static CookieSpec getCookieSpec(java.lang.String id)
                                throws java.lang.IllegalStateException
Gets the cookie specification with the given ID.

Parameters:
id - the cookie specification ID
Returns:
cookie specification
Throws:
java.lang.IllegalStateException - if a policy with the ID cannot be found
Since:
3.0

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


Copyright © 2002-2007 Oakland Software Incorporated. All Rights Reserved.