Klasse DefaultCookieParser

java.lang.Object
org.apache.fulcrum.parser.BaseValueParser
org.apache.fulcrum.parser.DefaultCookieParser
Alle implementierten Schnittstellen:
Iterable<String>, org.apache.avalon.framework.logger.LogEnabled, CookieParser, ParserServiceSupport, ValueParser

public class DefaultCookieParser extends BaseValueParser implements CookieParser
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$
Autor:
Ilkka Priha, Leon Messerschmidt, Thomas Vandahl
  • Konstruktordetails

    • DefaultCookieParser

      public DefaultCookieParser()
      Constructs a new CookieParser.
  • Methodendetails

    • dispose

      public void dispose()
      Disposes the parser.
      Angegeben von:
      dispose in Schnittstelle ValueParser
      Setzt außer Kraft:
      dispose in Klasse BaseValueParser
    • getRequest

      public HttpServletRequest getRequest()
      Gets the servlet request.
      Angegeben von:
      getRequest in Schnittstelle CookieParser
      Gibt zurück:
      the servlet request object or null.
    • setData

      public void setData(HttpServletRequest request, HttpServletResponse response)
      Sets the servlet request and response to be parsed. All previous cookies will be cleared.
      Angegeben von:
      setData in Schnittstelle CookieParser
      Parameter:
      request - the servlet request object.
      response - the servlet response object
    • set

      public void set(String name, String value)
      Set a cookie that will be stored on the client for the duration of the session.
      Angegeben von:
      set in Schnittstelle CookieParser
      Parameter:
      name - The name of the cookie
      value - The value of the cooking
    • set

      public void set(String name, String value, int secondsAge)
      Beschreibung aus Schnittstelle kopiert: CookieParser
      Set a persistent cookie on the client that will expire after a maximum age (given in seconds).
      Angegeben von:
      set in Schnittstelle CookieParser
      Parameter:
      name - A String for the name
      value - A String for the value
      secondsAge - An int for the age in seconds
    • unset

      public void unset(String name)
      Beschreibung aus Schnittstelle kopiert: CookieParser
      Remove a previously set cookie from the client machine.
      Angegeben von:
      unset in Schnittstelle CookieParser
      Parameter:
      name - the name of the cooking to unset
    • isValid

      public boolean isValid()
      Angegeben von:
      isValid in Schnittstelle CookieParser
      Setzt außer Kraft:
      isValid in Klasse BaseValueParser