|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.velocity.tools.view.CookieTool
@DefaultKey(value="cookies") @ValidScope(value="request") public class CookieTool
View tool for convenient cookie access and creation.
Template example(s): $cookie.foo $cookie.add("bar",'woogie') tools.xml configuration: <tools> <toolbox scope="request"> <tool class="org.apache.velocity.tools.view.CookieTool"/> </toolbox> </tools>
This class is only designed for use as a request-scope tool.
Nested Class Summary | |
---|---|
static class |
CookieTool.SugarCookie
Extends Cookie to add some fluid API sugar and
a toString() method that renders the Cookie's value
instead of the usual Object.toString() shenanigans. |
Field Summary | |
---|---|
protected Log |
log
|
protected javax.servlet.http.HttpServletRequest |
request
|
protected javax.servlet.http.HttpServletResponse |
response
|
Constructor Summary | |
---|---|
CookieTool()
|
Method Summary | |
---|---|
String |
add(javax.servlet.http.Cookie c)
Adds the specified Cookie to the HttpServletResponse. |
String |
add(String name,
String value)
Adds a new Cookie with the specified name and value to the HttpServletResponse. |
String |
add(String name,
String value,
Object maxAge)
Convenience method to add a new Cookie to the response and set an expiry time for it. |
javax.servlet.http.Cookie |
create(String name,
String value)
Creates a new Cookie with the specified name and value. |
javax.servlet.http.Cookie |
create(String name,
String value,
Object maxAge)
Convenience method to create a new Cookie and set an expiry time for it. |
String |
delete(String name)
Retrieves the specified cookie and sets the Max-Age to 0 to tell the browser to delete the cookie. |
javax.servlet.http.Cookie |
get(String name)
Returns the Cookie with the specified name, if it exists. |
List<javax.servlet.http.Cookie> |
getAll()
Expose array of Cookies for this request to the template. |
void |
setLog(Log log)
Sets the Log used for logging messages when Cookie
creation fails due to an invalid name. |
void |
setRequest(javax.servlet.http.HttpServletRequest request)
Sets the current HttpServletRequest . |
void |
setResponse(javax.servlet.http.HttpServletResponse response)
Sets the current HttpServletResponse . |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected javax.servlet.http.HttpServletRequest request
protected javax.servlet.http.HttpServletResponse response
protected Log log
Constructor Detail |
---|
public CookieTool()
Method Detail |
---|
public void setRequest(javax.servlet.http.HttpServletRequest request)
HttpServletRequest
. This is required
for this tool to operate and will throw a NullPointerException
if this is not set or is set to null
.
public void setResponse(javax.servlet.http.HttpServletResponse response)
HttpServletResponse
. This is required
for this tool to operate and will throw a NullPointerException
if this is not set or is set to null
.
public void setLog(Log log)
Log
used for logging messages when Cookie
creation fails due to an invalid name.
public List<javax.servlet.http.Cookie> getAll()
This is equivalent to $request.cookies
.
public javax.servlet.http.Cookie get(String name)
So, if you had a cookie named 'foo', you'd get it's value
by $cookies.foo.value
or it's max age
by $cookies.foo.maxAge
public String add(javax.servlet.http.Cookie c)
c
- is for cookie (that's good enough for me)
public String add(String name, String value)
name
- the name to give this cookievalue
- the value to be set for this cookie
public String add(String name, String value, Object maxAge)
name
- the name to give this cookievalue
- the value to be set for this cookiemaxAge
- the expiry to be set for this cookie
public javax.servlet.http.Cookie create(String name, String value)
$cookies.add($myCookie)
.
name
- the name to give this cookievalue
- the value to be set for this cookie
public javax.servlet.http.Cookie create(String name, String value, Object maxAge)
name
- the name to give this cookievalue
- the value to be set for this cookiemaxAge
- the expiry to be set for this cookie
public String delete(String name)
name
- the name of the cookie to be eaten
Cookie.setMaxAge(int)
,
add(Cookie)
,
get(String)
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |