001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.core.misc.upload;
066:
067: /* ====================================================================
068: * The Apache Software License, Version 1.1
069: *
070: * Copyright (c) 2001 The Apache Software Foundation. All rights
071: * reserved.
072: *
073: * Redistribution and use in source and binary forms, with or without
074: * modification, are permitted provided that the following conditions
075: * are met:
076: *
077: * 1. Redistributions of source code must retain the above copyright
078: * notice, this list of conditions and the following disclaimer.
079: *
080: * 2. Redistributions in binary form must reproduce the above copyright
081: * notice, this list of conditions and the following disclaimer in
082: * the documentation and/or other materials provided with the
083: * distribution.
084: *
085: * 3. The end-user documentation included with the redistribution,
086: * if any, must include the following acknowledgment:
087: * "This product includes software developed by the
088: * Apache Software Foundation (http://www.apache.org/)."
089: * Alternately, this acknowledgment may appear in the software itself,
090: * if and wherever such third-party acknowledgments normally appear.
091: *
092: * 4. The names "Apache" and "Apache Software Foundation" and
093: * "Apache Turbine" must not be used to endorse or promote products
094: * derived from this software without prior written permission. For
095: * written permission, please contact apache@apache.org.
096: *
097: * 5. Products derived from this software may not be called "Apache",
098: * "Apache Turbine", nor may "Apache" appear in their name, without
099: * prior written permission of the Apache Software Foundation.
100: *
101: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
102: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
103: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
104: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
105: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
106: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
107: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
108: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
109: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
110: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
111: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
112: * SUCH DAMAGE.
113: * ====================================================================
114: *
115: * This software consists of voluntary contributions made by many
116: * individuals on behalf of the Apache Software Foundation. For more
117: * information on the Apache Software Foundation, please see
118: * <http://www.apache.org/>.
119: */
120: // Java Servlet Classes
121: import javax.servlet.http.HttpServletRequest;
122:
123: /**
124: * ParameterParser is an interface to a utility to handle parsing and
125: * retrieving the data passed via the GET/POST/PATH_INFO arguments.
126: * <p/>
127: * <p>NOTE: The name= portion of a name=value pair may be converted
128: * to lowercase or uppercase when the object is initialized and when
129: * new data is added. This behaviour is determined by the url.case.folding
130: * property in TurbineResources.properties. Adding a name/value pair may
131: * overwrite existing name=value pairs if the names match:
132: * <p/>
133: * <pre>
134: * ParameterParser pp = data.getParameters();
135: * pp.add("ERROR",1);
136: * pp.add("eRrOr",2);
137: * int result = pp.getInt("ERROR");
138: * </pre>
139: * <p/>
140: * In the above example, result is 2.
141: *
142: * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
143: * @author <a href="mailto:jon@clearink.com">Jon S. Stevens</a>
144: * @author <a href="mailto:sean@informage.net">Sean Legassick</a>
145: * @version $Id: ParameterParser.java,v 1.6 2004/11/17 20:48:13 lhamel Exp $
146: */
147: public interface ParameterParser extends ValueParser {
148: /**
149: * Gets the parsed servlet request.
150: *
151: * @return the parsed servlet request or null.
152: */
153: public HttpServletRequest getRequest();
154:
155: /**
156: * Sets the servlet request to be parser. This requires a
157: * valid HttpServletRequest object. It will attempt to parse out
158: * the GET/POST/PATH_INFO data and store the data into a Hashtable.
159: * There are convenience methods for retrieving the data as a
160: * number of different datatypes. The PATH_INFO data must be a
161: * URLEncoded() string.
162: * <p/>
163: * <p>To add name/value pairs to this set of parameters, use the
164: * <code>add()</code> methods.
165: *
166: * @param req An HttpServletRequest.
167: */
168: public void setRequest(HttpServletRequest req);
169:
170: /**
171: * Sets the uploadData byte[]
172: *
173: * @param uploadData A byte[] with data.
174: */
175: public void setUploadData(byte[] uploadData);
176:
177: /**
178: * Gets the uploadData byte[]
179: *
180: * @return uploadData A byte[] with data.
181: */
182: public byte[] setUploadData();
183:
184: /**
185: * Add a FileItem object as a parameters. If there are any
186: * FileItems already associated with the name, append to the
187: * array. The reason for this is that RFC 1867 allows multiple
188: * files to be associated with single HTML input element.
189: *
190: * @param name A String with the name.
191: * @param value A FileItem with the value.
192: */
193: public void append(String name, FileItem value);
194:
195: /**
196: * Return a FileItem object for the given name. If the name does
197: * not exist or the object stored is not a FileItem, return null.
198: *
199: * @param name A String with the name.
200: * @return A FileItem.
201: */
202: public FileItem getFileItem(String name);
203:
204: /**
205: * Return an array of FileItem objects for the given name. If the
206: * name does not exist or the object stored is not a FileItem
207: * array, return null.
208: *
209: * @param name A String with the name.
210: * @return A FileItem[].
211: */
212: public FileItem[] getFileItems(String name);
213:
214: }
|