org.apache.turbine.util.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 534527 2007-05-02 16:10:59Z tv $
Author:
Ilkka Priha, Leon Messerschmidt

Field Summary
static int AGE_DELETE
           
static int AGE_SESSION
           
 
Fields inherited from interface org.apache.turbine.util.parser.ValueParser
URL_CASE_FOLDING, URL_CASE_FOLDING_LOWER, URL_CASE_FOLDING_NONE, URL_CASE_FOLDING_UPPER
 
Method Summary
 URI getCookiePath()
          Get the Path where cookies will be stored
 javax.servlet.http.HttpServletRequest getRequest()
          Gets the Request Object for this parser.
 RunData getRunData()
          Gets the parsed RunData.
 void set(java.lang.String name, java.lang.String value)
          Set a cookie that will be stored on the client for the duration of the session.
 void set(java.lang.String name, java.lang.String value, int seconds_age)
          Set a persisten cookie on the client that will expire after a maximum age (given in seconds).
 void setCookiePath(URI path)
          Set the path for cookie storage
 void setData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sets Request and Response to be parsed.
 void setRunData(RunData data)
          Sets the RunData to be parsed.
 void unset(java.lang.String name)
          Remove a previously set cookie from the client machine.
 
Methods inherited from interface org.apache.turbine.util.parser.ValueParser
add, add, add, add, add, add, append, clear, containsDateSelectorKeys, containsKey, convert, get, getBigDecimal, getBigDecimal, getBigDecimals, getBool, getBool, 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, getInteger, getInteger, getInteger, getIntegers, getIntObject, getIntObject, getIntObjects, getInts, getKeys, getLocale, getLong, getLong, getLongObject, getLongObject, getLongObjects, getLongs, getNumberFormat, getNumberKey, getObject, getObjects, getString, getString, getStringKey, getStrings, getStrings, keys, keySet, remove, setCharacterEncoding, setDateFormat, setLocale, setNumberFormat, setProperties, setString, setStrings, toString
 

Field Detail

AGE_SESSION

public static final int AGE_SESSION
See Also:
Constant Field Values

AGE_DELETE

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

getRunData

public RunData getRunData()
Gets the parsed RunData.

Returns:
the parsed RunData object or null.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()
Gets the Request Object for this parser.

Returns:
the HttpServletRequest or null.

setRunData

public void setRunData(RunData data)
Sets the RunData to be parsed. All previous cookies will be cleared.

Parameters:
data - the RunData object.

setData

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

Parameters:
request - The http request from the servlet
response - The http reponse from the servlet

getCookiePath

public URI getCookiePath()
Get the Path where cookies will be stored


setCookiePath

public void setCookiePath(URI path)
Set the path for cookie storage


set

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


set

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


unset

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



Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.