votorola.g.web

Class CookieX

java.lang.Object

javax.servlet.http.Cookie

CookieX

All Implemented Interfaces:

Cloneable

public class CookieX
extends Cookie

An extended cookie implementation that rejects illegal values. The superclass accepts illegal values and depending on the servlet container may encode them by RFC 2965 quoting, which is not supported by all browsers. So we do our own testing and encoding here in compliance with both the original and existing standards.

See Also:

Persistent client state: HTTP cookies, RFC 2965, Allowed characters in cookies

Field Summary

Fields

Modifier and Type	Field and Description
static int	DURATION_YEAR_S A max-age value of roughly one year as measured in seconds.

Constructor Summary

Constructors

Constructor and Description
CookieX(String name, String value) Constructs a CookieX without encoding the value.
CookieX(String name, String value, boolean toEncode) Constructs a CookieX.

Method Summary

Methods

Modifier and Type	Method and Description
static String	decodedValue(String encodedValue) Decodes a previously encodedValue and returns the result.
static String	encodedValue(String decodedValue) Encodes the value such that it has no illegal characters and returns the result.
void	setValue(String value)
void	setValue(String value, boolean toEncode)
void	setVersion(int version)

Methods inherited from class javax.servlet.http.Cookie

clone, getComment, getDomain, getMaxAge, getName, getPath, getSecure, getValue, getVersion, setComment, setDomain, setMaxAge, setPath, setSecure

Methods inherited from class java.lang.Object

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

Field Detail

DURATION_YEAR_S

public static final int DURATION_YEAR_S

A max-age value of roughly one year as measured in seconds.

See Also:

Constant Field Values

Constructor Detail

CookieX

public CookieX(String name,
       String value)

Constructs a CookieX without encoding the value.

Throws:

IllegalArgumentException - if either the name or value contains an illegal character.

See Also:

Cookie.getName(), Cookie.getValue(), Cookie.Cookie(String,String)

CookieX

public CookieX(String name,
       String value,
       boolean toEncode)

Constructs a CookieX.

Parameters:

toEncode - whether to encode the value. If

Throws:

IllegalArgumentException - if the name contains an illegal character, or if the value contains an illegal character and assertions are enabled.

See Also:

Cookie.getName(), Cookie.getValue(), Cookie.Cookie(String,String)

Method Detail

decodedValue

@ThreadSafe
public static String decodedValue(String encodedValue)

Decodes a previously encodedValue and returns the result.

Parameters:

encodedValue - the value to decode. Null values decode to null.

See Also:

encodedValue(String)

encodedValue

@ThreadSafe
public static String encodedValue(String decodedValue)

Encodes the value such that it has no illegal characters and returns the result. This method uses URI "percent" escaping based on UTF-8 ordinals for any non-ASCII characters. This is also the encoding method recommended for URIs.

Parameters:

decodedValue - the value to encode. Null values encode to null.

See Also:

decodedValue(String), Non-ASCII characters in URI attribute values

setValue

public final void setValue(String value)

Overrides:

setValue in class Cookie

Throws:

IllegalArgumentException - if the value contains an illegal character.

setValue

public final void setValue(String value,
            boolean toEncode)

Throws:

IllegalArgumentException - if the value contains an illegal character and assertions are enabled.

setVersion

public final void setVersion(int version)

Overrides:

setVersion in class Cookie

Throws:

IllegalArgumentException - if the version is not zero. The argument checking performed by this class is probably not necessary for later versions.