View Javadoc
1 package org.apache.turbine.util; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 /*** 58 * CookieParser is an interface to a utility to to get and set values 59 * of Cookies on the Client Browser. You can use CookieParser to convert 60 * Cookie values to various types or to set Bean values with setParameters(). 61 * Servlet Spec for more information on Cookies. 62 * <p> 63 * Use set() or unset() to Create or Destroy Cookies. 64 * <p> 65 * NOTE: The name= portion of a name=value pair may be converted 66 * to lowercase or uppercase when the object is initialized and when 67 * new data is added. This behaviour is determined by the url.case.folding 68 * property in TurbineResources.properties. Adding a name/value pair may 69 * overwrite existing name=value pairs if the names match: 70 * 71 * <pre> 72 * CookieParser cp = data.getCookies(); 73 * cp.add("ERROR",1); 74 * cp.add("eRrOr",2); 75 * int result = cp.getInt("ERROR"); 76 * </pre> 77 * 78 * In the above example, result is 2. 79 * 80 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a> 81 * @author <a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a> 82 * @version $Id: CookieParser.java,v 1.1.1.1 2001/08/16 05:09:38 jvanzyl Exp $ 83 */ 84 public interface CookieParser 85 extends ValueParser 86 { 87 public static final int AGE_SESSION = -1; 88 public static final int AGE_DELETE = 0; 89 90 /*** 91 * Gets the parsed RunData. 92 * 93 * @return the parsed RunData object or null. 94 */ 95 public RunData getRunData(); 96 97 /*** 98 * Sets the RunData to be parsed. 99 * All previous cookies will be cleared. 100 * 101 * @param data the RunData object. 102 */ 103 public void setRunData (RunData data); 104 105 /*** 106 * Get the Path where cookies will be stored 107 */ 108 public DynamicURI getCookiePath(); 109 110 /*** 111 * Set the path for cookie storage 112 */ 113 public void setCookiePath (DynamicURI path); 114 115 /*** 116 * Set a cookie that will be stored on the client for 117 * the duration of the session. 118 */ 119 public void set (String name, String value); 120 121 /*** 122 * Set a persisten cookie on the client that will expire 123 * after a maximum age (given in seconds). 124 */ 125 public void set (String name, String value, int seconds_age); 126 127 /*** 128 * Remove a previously set cookie from the client machine. 129 */ 130 public void unset (String name); 131 }

This page was automatically generated by Maven