| org.apache.turbine.util.parser.BaseValueParser
 org.apache.turbine.util.parser.DefaultCookieParser
| DefaultCookieParser | | public class DefaultCookieParser extends BaseValueParser implements CookieParser,Recyclable(Code) | | 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.
author:
Ilkka Priha
author:
Leon Messerschmidt
author:
Henning P. Schmiedehausen
version:
$Id: DefaultCookieParser.java 534527 2007-05-02 16:10:59Z tv $ |
| DefaultCookieParser | | public DefaultCookieParser()(Code) | | Constructs a new CookieParser.
|
| dispose | | public void dispose()(Code) | | Disposes the parser.
|
| getCookiePath | | public URI getCookiePath()(Code) | | Get the Path where cookies will be stored
path for cookie storage |
| getRequest | | public HttpServletRequest getRequest()(Code) | | Gets the Request Object for this parser.
the HttpServletRequest or null. |
| getRunData | | public RunData getRunData()(Code) | | Gets the parsed RunData.
the parsed RunData object or null. |
| set | | public void set(String name, String value)(Code) | | Set a cookie that will be stored on the client for
the duration of the session.
Parameters:
name - name of the cookie
Parameters:
value - value of the cookie |
| set | | public void set(String name, String value, int seconds_age)(Code) | | Set a persisten cookie on the client that will expire
after a maximum age (given in seconds).
Parameters:
name - name of the cookie
Parameters:
value - value of the cookie
Parameters:
seconds_age - max age of the cookie in seconds |
| setCookiePath | | public void setCookiePath(URI cookiePath)(Code) | | Set the path for cookie storage
Parameters:
cookiePath - path for cookie storage |
| setData | | public void setData(HttpServletRequest request, HttpServletResponse response)(Code) | | Sets Request and Response to be parsed.
All previous cookies will be cleared.
Parameters:
request - The http request from the servlet
Parameters:
response - The http reponse from the servlet |
| setRunData | | public void setRunData(RunData data)(Code) | | Sets the RunData to be parsed. This is a convenience method to
set the request and response from the RunData object. It is
equivalent to
setData(data.getRequest(), data.getResponse());
All previous cookies will be cleared.
Parameters:
data - the RunData object. |
| unset | | public void unset(String name)(Code) | | Remove a previously set cookie from the client machine.
Parameters:
name - name of the cookie |
| Methods inherited from org.apache.turbine.util.parser.BaseValueParser | public void add(String name, double value)(Code)(Java Doc)
public void add(String name, int value)(Code)(Java Doc)
public void add(String name, Integer value)(Code)(Java Doc)
public void add(String name, long value)(Code)(Java Doc)
public void add(String name, String value)(Code)(Java Doc)
public void add(String name, String[] value)(Code)(Java Doc)
public void append(String name, String value)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean containsDateSelectorKeys(String key)(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsTimeSelectorKeys(String key)(Code)(Java Doc)
public String convert(String value)(Code)(Java Doc)
public static String convertAndTrim(String value)(Code)(Java Doc)
public void dispose()(Code)(Java Doc)
public String get(String name)(Code)(Java Doc)
public BigDecimal getBigDecimal(String name, BigDecimal defaultValue)(Code)(Java Doc)
public BigDecimal getBigDecimal(String name)(Code)(Java Doc)
public BigDecimal[] getBigDecimals(String name)(Code)(Java Doc)
public Boolean getBool(String name, boolean defaultValue)(Code)(Java Doc)
public Boolean getBool(String name)(Code)(Java Doc)
public boolean getBoolean(String name, boolean defaultValue)(Code)(Java Doc)
public boolean getBoolean(String name)(Code)(Java Doc)
public Boolean getBooleanObject(String name)(Code)(Java Doc)
public Boolean getBooleanObject(String name, Boolean defaultValue)(Code)(Java Doc)
public byte getByte(String name, byte defaultValue)(Code)(Java Doc)
public byte getByte(String name)(Code)(Java Doc)
public Byte getByteObject(String name, Byte defaultValue)(Code)(Java Doc)
public Byte getByteObject(String name)(Code)(Java Doc)
public byte[] getBytes(String name) throws UnsupportedEncodingException(Code)(Java Doc)
public String getCharacterEncoding()(Code)(Java Doc)
public Date getDate(String name, DateFormat df, Date defaultValue)(Code)(Java Doc)
public Date getDate(String name)(Code)(Java Doc)
public Date getDate(String name, DateFormat df)(Code)(Java Doc)
public double getDouble(String name, double defaultValue)(Code)(Java Doc)
public double getDouble(String name)(Code)(Java Doc)
public Double getDoubleObject(String name, Double defaultValue)(Code)(Java Doc)
public Double getDoubleObject(String name)(Code)(Java Doc)
public Double[] getDoubleObjects(String name)(Code)(Java Doc)
public double[] getDoubles(String name)(Code)(Java Doc)
public float getFloat(String name, float defaultValue)(Code)(Java Doc)
public float getFloat(String name)(Code)(Java Doc)
public Float getFloatObject(String name, Float defaultValue)(Code)(Java Doc)
public Float getFloatObject(String name)(Code)(Java Doc)
public Float[] getFloatObjects(String name)(Code)(Java Doc)
public float[] getFloats(String name)(Code)(Java Doc)
public int getInt(String name, int defaultValue)(Code)(Java Doc)
public int getInt(String name)(Code)(Java Doc)
public Integer getIntObject(String name, Integer defaultValue)(Code)(Java Doc)
public Integer getIntObject(String name)(Code)(Java Doc)
public Integer[] getIntObjects(String name)(Code)(Java Doc)
public Integer getInteger(String name, int defaultValue)(Code)(Java Doc)
public Integer getInteger(String name, Integer def)(Code)(Java Doc)
public Integer getInteger(String name)(Code)(Java Doc)
public Integer[] getIntegers(String name)(Code)(Java Doc)
public int[] getInts(String name)(Code)(Java Doc)
public Object[] getKeys()(Code)(Java Doc)
public long getLong(String name, long defaultValue)(Code)(Java Doc)
public long getLong(String name)(Code)(Java Doc)
public Long getLongObject(String name)(Code)(Java Doc)
public Long getLongObject(String name, Long defaultValue)(Code)(Java Doc)
public Long[] getLongObjects(String name)(Code)(Java Doc)
public long[] getLongs(String name)(Code)(Java Doc)
public NumberKey getNumberKey(String name)(Code)(Java Doc)
public Object getObject(String name)(Code)(Java Doc)
public Object[] getObjects(String name)(Code)(Java Doc)
protected String[] getParam(String name)(Code)(Java Doc)
public String getString(String name)(Code)(Java Doc)
public String getString(String name, String defaultValue)(Code)(Java Doc)
public StringKey getStringKey(String name)(Code)(Java Doc)
public String[] getStrings(String name)(Code)(Java Doc)
public String[] getStrings(String name, String[] defaultValue)(Code)(Java Doc)
protected Object[] getToStringParam(String name)(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
public Enumeration keys()(Code)(Java Doc)
protected void putParam(String name, String[] value)(Code)(Java Doc)
public void recycle(String characterEncoding)(Code)(Java Doc)
public Object remove(String name)(Code)(Java Doc)
public void setCharacterEncoding(String s)(Code)(Java Doc)
public void setProperties(Object bean) throws Exception(Code)(Java Doc)
protected void setProperty(Object bean, PropertyDescriptor prop) throws Exception(Code)(Java Doc)
public void setString(String name, String value)(Code)(Java Doc)
public void setStrings(String name, String[] values)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|