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
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, parserServiceFields inherited from interface org.apache.fulcrum.parser.CookieParser
AGE_DELETE, AGE_SESSIONFields inherited from interface org.apache.fulcrum.parser.ValueParser
DEFAULT_CHARACTER_ENCODING -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Disposes the parser.jakarta.servlet.http.HttpServletRequestGets the servlet request.booleanisValid()voidSet a cookie that will be stored on the client for the duration of the session.voidSet a persistent cookie on the client that will expire after a maximum age (given in seconds).voidsetData(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Sets the servlet request and response to be parsed.voidRemove 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, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods 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 Details
-
DefaultCookieParser
public DefaultCookieParser()Constructs a new CookieParser.
-
-
Method Details
-
dispose
public void dispose()Disposes the parser.- Specified by:
disposein interfaceValueParser- Overrides:
disposein classBaseValueParser
-
getRequest
public jakarta.servlet.http.HttpServletRequest getRequest()Gets the servlet request.- Specified by:
getRequestin interfaceCookieParser- Returns:
- the servlet request object or null.
-
setData
public void setData(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Sets the servlet request and response to be parsed. All previous cookies will be cleared.- Specified by:
setDatain interfaceCookieParser- Parameters:
request- the servlet request object.response- the servlet response object
-
set
Set a cookie that will be stored on the client for the duration of the session.- Specified by:
setin interfaceCookieParser- Parameters:
name- The name of the cookievalue- The value of the cooking
-
set
Description copied from interface:CookieParserSet a persistent cookie on the client that will expire after a maximum age (given in seconds).- Specified by:
setin interfaceCookieParser- Parameters:
name- A String for the namevalue- A String for the valuesecondsAge- An int for the age in seconds
-
unset
Description copied from interface:CookieParserRemove a previously set cookie from the client machine.- Specified by:
unsetin interfaceCookieParser- Parameters:
name- the name of the cooking to unset
-
isValid
public boolean isValid()- Specified by:
isValidin interfaceCookieParser- Overrides:
isValidin classBaseValueParser
-