程序包 org.apache.velocity.tools.view

类 CookieTool

java.lang.Object
org.apache.velocity.tools.generic.SafeConfig
org.apache.velocity.tools.view.CookieTool
@DefaultKey("cookies") @ValidScope("request") public class CookieTool extends SafeConfig

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.

从以下版本开始:
VelocityTools 2.0
版本:
$Id$
作者:
Dmitri Colebatch, Nathan Bubna

  • 字段详细资料

    • log

      protected static org.slf4j.Logger log

    • request

      protected jakarta.servlet.http.HttpServletRequest request

    • response

      protected jakarta.servlet.http.HttpServletResponse response

  • 构造器详细资料

    • CookieTool

      public CookieTool()

  • 方法详细资料

    • setRequest

      public void setRequest(jakarta.servlet.http.HttpServletRequest request)
      Sets the current HttpServletRequest. This is required for this tool to operate and will throw a NullPointerException if this is not set or is set to null.
      参数:
      request - servlet request

    • setResponse

      public void setResponse(jakarta.servlet.http.HttpServletResponse response)
      Sets the current HttpServletResponse. This is required for this tool to operate and will throw a NullPointerException if this is not set or is set to null.
      参数:
      response - servlet response

    • getAll

      public List<jakarta.servlet.http.Cookie> getAll()
      Expose array of Cookies for this request to the template.

      This is equivalent to $request.cookies.

      返回:
      list of Cookie objects for this request

    • get

      public jakarta.servlet.http.Cookie get(String name)
      Returns the Cookie with the specified name, if it exists.

      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

      参数:
      name - cookie name
      返回:
      found cookie or null

    • add

      public String add(jakarta.servlet.http.Cookie c)
      Adds the specified Cookie to the HttpServletResponse. This does *not* add the Cookie to the current request.
      参数:
      c - is for cookie (that's good enough for me)
      返回:
      an empty String to prevent the reference from rendering unless the cookie passed in is null, then it returns null
      从以下版本开始:
      VelocityTools 2.0

    • add

      public String add(String name, String value)
      Adds a new Cookie with the specified name and value to the HttpServletResponse. This does *not* add a Cookie to the current request.
      参数:
      name - the name to give this cookie
      value - the value to be set for this cookie
      返回:
      an empty String to prevent the reference from rendering

    • add

      public 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.
      参数:
      name - the name to give this cookie
      value - the value to be set for this cookie
      maxAge - the expiry to be set for this cookie
      返回:
      an empty String to prevent the reference from rendering

    • create

      public jakarta.servlet.http.Cookie create(String name, String value)
      Creates a new Cookie with the specified name and value. This does *not* add the Cookie to the response, so the created Cookie will not be set unless you do $cookies.add($myCookie).
      参数:
      name - the name to give this cookie
      value - the value to be set for this cookie
      返回:
      The new SugarCookie object.
      从以下版本开始:
      VelocityTools 1.3

    • create

      public jakarta.servlet.http.Cookie create(String name, String value, Object maxAge)
      Convenience method to create a new Cookie and set an expiry time for it.
      参数:
      name - the name to give this cookie
      value - the value to be set for this cookie
      maxAge - the expiry to be set for this cookie
      返回:
      The new SugarCookie object.
      从以下版本开始:
      VelocityTools 1.3

    • delete

      public String delete(String name)
      Retrieves the specified cookie and sets the Max-Age to 0 to tell the browser to delete the cookie. Then this returns an empty string to make this render silently. If no such cookie exists, then it returns null to show the error.
      参数:
      name - the name of the cookie to be eaten
      返回:
      empty string, or null if no such cookie exists
      另请参阅:

    • toString

      public String toString()
      覆盖:
      toString 在类中 Object