Package org.apache.fulcrum.parser

Class DefaultCookieParser

java.lang.Object

org.apache.fulcrum.parser.BaseValueParser

org.apache.fulcrum.parser.DefaultCookieParser

All Implemented Interfaces:

Iterable<String>, org.apache.avalon.framework.logger.LogEnabled, CookieParser, ParserServiceSupport, ValueParser

public class DefaultCookieParser
extends BaseValueParser
implements CookieParser

CookieParser is used to get and set values of Cookies on the Client Browser. You can use CookieParser to convert Cookie values to various types or to set Bean values with setParameters(). See the Servlet Spec for more information on Cookies.

Use set() or unset() to Create or Destroy Cookies.

NOTE: The name= portion of a name=value pair may be converted to lowercase or uppercase when the object is initialized and when new data is added. This behaviour is determined by the url.case.folding property in TurbineResources.properties. Adding a name/value pair may overwrite existing name=value pairs if the names match:

 CookieParser cp = data.getCookies();
 cp.add("ERROR",1);
 cp.add("eRrOr",2);
 int result = cp.getInt("ERROR");
 

In the above example, result is 2.

Version:

$Id$

Author:

Ilkka Priha, Leon Messerschmidt, Thomas Vandahl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.fulcrum.parser.ValueParser

ValueParser.URLCaseFolding

Field Summary

Fields inherited from class org.apache.fulcrum.parser.BaseValueParser

parameters, parserService

Fields inherited from interface org.apache.fulcrum.parser.CookieParser

AGE_DELETE, AGE_SESSION

Fields inherited from interface org.apache.fulcrum.parser.ValueParser

DEFAULT_CHARACTER_ENCODING

Constructor Summary

Constructors

Constructor	Description
DefaultCookieParser()	Constructs a new CookieParser.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes the parser.
HttpServletRequest	getRequest()	Gets the servlet request.
boolean	isValid()
void	set(String name, String value)	Set a cookie that will be stored on the client for the duration of the session.
void	set(String name, String value, int secondsAge)	Set a persistent cookie on the client that will expire after a maximum age (given in seconds).
void	setData(HttpServletRequest request, HttpServletResponse response)	Sets the servlet request and response to be parsed.
void	unset(String name)	Remove a previously set cookie from the client machine.

Methods inherited from class org.apache.fulcrum.parser.BaseValueParser

add, add, add, add, add, add, clear, containsKey, convert, convertAndTrim, convertAndTrim, enableLogging, get, getBigDecimal, getBigDecimal, getBigDecimals, getBoolean, getBoolean, getBooleanObject, getBooleanObject, getBooleanObjects, getBooleans, getByte, getByte, getByteObject, getByteObject, getBytes, getCharacterEncoding, getDate, getDate, getDate, getDateFormat, getDouble, getDouble, getDoubleObject, getDoubleObject, getDoubleObjects, getDoubles, getFloat, getFloat, getFloatObject, getFloatObject, getFloatObjects, getFloats, getInt, getInt, getIntObject, getIntObject, getIntObjects, getInts, getKeys, getLocale, getLogger, getLong, getLong, getLongObject, getLongObject, getLongObjects, getLongs, getNumberFormat, getObject, getObjects, getParam, getString, getString, getStrings, getStrings, getToStringParam, getUrlFolding, isDisposed, iterator, keySet, putParam, recycle, recycle, remove, setCharacterEncoding, setDateFormat, setLocale, setNumberFormat, setParserService, setProperties, setProperty, setString, setStrings, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.fulcrum.parser.ValueParser

add, add, add, add, add, add, clear, containsKey, convert, convertAndTrim, convertAndTrim, get, getBigDecimal, getBigDecimal, getBigDecimals, getBoolean, getBoolean, getBooleanObject, getBooleanObject, getBooleanObjects, getBooleans, getByte, getByte, getByteObject, getByteObject, getBytes, getCharacterEncoding, getDate, getDate, getDate, getDateFormat, getDouble, getDouble, getDoubleObject, getDoubleObject, getDoubleObjects, getDoubles, getFloat, getFloat, getFloatObject, getFloatObject, getFloatObjects, getFloats, getInt, getInt, getIntObject, getIntObject, getIntObjects, getInts, getKeys, getLocale, getLong, getLong, getLongObject, getLongObject, getLongObjects, getLongs, getNumberFormat, getObject, getObjects, getString, getString, getStrings, getStrings, getUrlFolding, keySet, remove, setCharacterEncoding, setDateFormat, setLocale, setNumberFormat, setProperties, setString, setStrings, toString

Constructor Detail

DefaultCookieParser

public DefaultCookieParser()

Constructs a new CookieParser.

Method Detail

dispose

public void dispose()

Disposes the parser.

Specified by:

dispose in interface ValueParser

Overrides:

dispose in class BaseValueParser

getRequest

public HttpServletRequest getRequest()

Gets the servlet request.

Specified by:

getRequest in interface CookieParser

Returns:

the servlet request object or null.

setData

public void setData(HttpServletRequest request,
                    HttpServletResponse response)

Sets the servlet request and response to be parsed. All previous cookies will be cleared.

Specified by:

setData in interface CookieParser

Parameters:

request - the servlet request object.

response - the servlet response object

set

public void set(String name,
                String value)

Set a cookie that will be stored on the client for the duration of the session.

Specified by:

set in interface CookieParser

Parameters:

name - The name of the cookie

value - The value of the cooking

set

public void set(String name,
                String value,
                int secondsAge)

Description copied from interface: CookieParser

Set a persistent cookie on the client that will expire after a maximum age (given in seconds).

Specified by:

set in interface CookieParser

Parameters:

name - A String for the name

value - A String for the value

secondsAge - An int for the age in seconds

unset

public void unset(String name)

Description copied from interface: CookieParser

Remove a previously set cookie from the client machine.

Specified by:

unset in interface CookieParser

Parameters:

name - the name of the cooking to unset

isValid

public boolean isValid()

Specified by:

isValid in interface CookieParser

Overrides:

isValid in class BaseValueParser