Package org.apache.fulcrum.parser
Interface CookieParser
- All Superinterfaces:
Iterable<String>
,ValueParser
- All Known Implementing Classes:
DefaultCookieParser
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$
- 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
FieldsFields inherited from interface org.apache.fulcrum.parser.ValueParser
DEFAULT_CHARACTER_ENCODING
-
Method Summary
Modifier and TypeMethodDescriptionjakarta.servlet.http.HttpServletRequest
Gets the servlet request.boolean
isValid()
void
Set a cookie that will be stored on the client for the duration of the session.void
Set a persistent cookie on the client that will expire after a maximum age (given in seconds).void
setData
(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Sets the servlet request and response to be parsed.void
Remove a previously set cookie from the client machine.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, dispose, 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 Details
-
AGE_SESSION
static final int AGE_SESSION- See Also:
-
AGE_DELETE
static final int AGE_DELETE- See Also:
-
-
Method Details
-
getRequest
jakarta.servlet.http.HttpServletRequest getRequest()Gets the servlet request.- Returns:
- the servlet request object or null.
-
setData
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.- 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.- Parameters:
name
- The name of the cookievalue
- The value of the cooking
-
set
Set a persistent cookie on the client that will expire after a maximum age (given in seconds).- Parameters:
name
- A String for the namevalue
- A String for the valueseconds_age
- An int for the age in seconds
-
unset
Remove a previously set cookie from the client machine.- Parameters:
name
- the name of the cooking to unset
-
isValid
boolean isValid()
-