public interface CookieParser extends ValueParser
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.
ValueParser.URLCaseFolding
Modifier and Type | Field and Description |
---|---|
static int |
AGE_DELETE |
static int |
AGE_SESSION |
DEFAULT_CHARACTER_ENCODING
Modifier and Type | Method and Description |
---|---|
HttpServletRequest |
getRequest()
Gets the servlet request.
|
boolean |
isValid() |
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 persistent cookie on the client that will expire
after a maximum age (given in seconds).
|
void |
setData(HttpServletRequest request,
HttpServletResponse response)
Sets the servlet request and response to be parsed.
|
void |
unset(String name)
Remove a previously set cookie from the client machine.
|
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
forEach, iterator, spliterator
static final int AGE_SESSION
static final int AGE_DELETE
HttpServletRequest getRequest()
void setData(HttpServletRequest request, HttpServletResponse response)
request
- the servlet request object.response
- the servlet response objectvoid set(String name, String value)
name
- The name of the cookievalue
- The value of the cookingvoid set(String name, String value, int seconds_age)
name
- A String for the namevalue
- A String for the valueseconds_age
- An int for the age in secondsvoid unset(String name)
name
- the name of the cooking to unsetboolean isValid()
Copyright © 2005–2019 The Apache Software Foundation. All rights reserved.