KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > misc > upload > ParameterParser


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.core.misc.upload;
66
67 /* ====================================================================
68  * The Apache Software License, Version 1.1
69  *
70  * Copyright (c) 2001 The Apache Software Foundation. All rights
71  * reserved.
72  *
73  * Redistribution and use in source and binary forms, with or without
74  * modification, are permitted provided that the following conditions
75  * are met:
76  *
77  * 1. Redistributions of source code must retain the above copyright
78  * notice, this list of conditions and the following disclaimer.
79  *
80  * 2. Redistributions in binary form must reproduce the above copyright
81  * notice, this list of conditions and the following disclaimer in
82  * the documentation and/or other materials provided with the
83  * distribution.
84  *
85  * 3. The end-user documentation included with the redistribution,
86  * if any, must include the following acknowledgment:
87  * "This product includes software developed by the
88  * Apache Software Foundation (http://www.apache.org/)."
89  * Alternately, this acknowledgment may appear in the software itself,
90  * if and wherever such third-party acknowledgments normally appear.
91  *
92  * 4. The names "Apache" and "Apache Software Foundation" and
93  * "Apache Turbine" must not be used to endorse or promote products
94  * derived from this software without prior written permission. For
95  * written permission, please contact apache@apache.org.
96  *
97  * 5. Products derived from this software may not be called "Apache",
98  * "Apache Turbine", nor may "Apache" appear in their name, without
99  * 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
122 import javax.servlet.http.HttpServletRequest JavaDoc;
123
124
125 /**
126  * ParameterParser is an interface to a utility to handle parsing and
127  * retrieving the data passed via the GET/POST/PATH_INFO arguments.
128  * <p/>
129  * <p>NOTE: The name= portion of a name=value pair may be converted
130  * to lowercase or uppercase when the object is initialized and when
131  * new data is added. This behaviour is determined by the url.case.folding
132  * property in TurbineResources.properties. Adding a name/value pair may
133  * overwrite existing name=value pairs if the names match:
134  * <p/>
135  * <pre>
136  * ParameterParser pp = data.getParameters();
137  * pp.add("ERROR",1);
138  * pp.add("eRrOr",2);
139  * int result = pp.getInt("ERROR");
140  * </pre>
141  * <p/>
142  * In the above example, result is 2.
143  *
144  * @author <a HREF="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
145  * @author <a HREF="mailto:jon@clearink.com">Jon S. Stevens</a>
146  * @author <a HREF="mailto:sean@informage.net">Sean Legassick</a>
147  * @version $Id: ParameterParser.java,v 1.6 2004/11/17 20:48:13 lhamel Exp $
148  */
149 public interface ParameterParser
150         extends ValueParser {
151     /**
152      * Gets the parsed servlet request.
153      *
154      * @return the parsed servlet request or null.
155      */
156     public HttpServletRequest JavaDoc getRequest();
157
158     /**
159      * Sets the servlet request to be parser. This requires a
160      * valid HttpServletRequest object. It will attempt to parse out
161      * the GET/POST/PATH_INFO data and store the data into a Hashtable.
162      * There are convenience methods for retrieving the data as a
163      * number of different datatypes. The PATH_INFO data must be a
164      * URLEncoded() string.
165      * <p/>
166      * <p>To add name/value pairs to this set of parameters, use the
167      * <code>add()</code> methods.
168      *
169      * @param req An HttpServletRequest.
170      */
171     public void setRequest(HttpServletRequest JavaDoc req);
172
173     /**
174      * Sets the uploadData byte[]
175      *
176      * @param uploadData A byte[] with data.
177      */
178     public void setUploadData(byte[] uploadData);
179
180     /**
181      * Gets the uploadData byte[]
182      *
183      * @return uploadData A byte[] with data.
184      */
185     public byte[] setUploadData();
186
187     /**
188      * Add a FileItem object as a parameters. If there are any
189      * FileItems already associated with the name, append to the
190      * array. The reason for this is that RFC 1867 allows multiple
191      * files to be associated with single HTML input element.
192      *
193      * @param name A String with the name.
194      * @param value A FileItem with the value.
195      */
196     public void append(String JavaDoc name, FileItem value);
197
198     /**
199      * Return a FileItem object for the given name. If the name does
200      * not exist or the object stored is not a FileItem, return null.
201      *
202      * @param name A String with the name.
203      * @return A FileItem.
204      */
205     public FileItem getFileItem(String JavaDoc name);
206
207     /**
208      * Return an array of FileItem objects for the given name. If the
209      * name does not exist or the object stored is not a FileItem
210      * array, return null.
211      *
212      * @param name A String with the name.
213      * @return A FileItem[].
214      */
215     public FileItem[] getFileItems(String JavaDoc name);
216
217 }
Popular Tags