org.apache.fulcrum.parser
Interface CookieParser

All Superinterfaces:
ValueParser
All Known Implementing Classes:
DefaultCookieParser

public interface CookieParser
extends ValueParser

CookieParser is an interface to a utility to 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(). 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: CookieParser.java 812786 2009-09-09 07:01:49Z tv $
Author:
Ilkka Priha, Leon Messerschmidt, Thomas Vandahl

Field Summary
static int AGE_DELETE
           
static int AGE_SESSION
           
 
Fields inherited from interface org.apache.fulcrum.parser.ValueParser
DEFAULT_CHARACTER_ENCODING
 
Method Summary
 javax.servlet.http.HttpServletRequest getRequest()
          Gets the servlet request.
 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 seconds_age)
          Set a persisten cookie on the client that will expire after a maximum age (given in seconds).
 void setData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.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 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
 

Field Detail

AGE_SESSION

static final int AGE_SESSION
See Also:
Constant Field Values

AGE_DELETE

static final int AGE_DELETE
See Also:
Constant Field Values
Method Detail

getRequest

javax.servlet.http.HttpServletRequest getRequest()
Gets the servlet request.

Returns:
the servlet request object or null.

setData

void setData(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
Sets the servlet request and response to be parsed. All previous cookies will be cleared.

Parameters:
request - the servlet request object.
response - the servlet response object

set

void set(String name,
         String value)
Set a cookie that will be stored on the client for the duration of the session.


set

void set(String name,
         String value,
         int seconds_age)
Set a persisten cookie on the client that will expire after a maximum age (given in seconds).


unset

void unset(String name)
Remove a previously set cookie from the client machine.



Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.