KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > fileupload > FileUpload


1 /*
2  * $Header: /home/cvs/jakarta-commons/fileupload/src/java/org/apache/commons/fileupload/FileUpload.java,v 1.23 2003/06/24 05:45:43 martinc Exp $
3  * $Revision: 1.23 $
4  * $Date: 2003/06/24 05:45:43 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowlegement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowlegement may appear in the software itself,
30  * if and wherever such third-party acknowlegements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Group.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  *
60  */
61
62
63 package org.apache.commons.fileupload;
64
65
66 /**
67  * <p>High level API for processing file uploads.</p>
68  *
69  * <p>This class handles multiple files per single HTML widget, sent using
70  * <code>multipart/mixed</code> encoding type, as specified by
71  * <a HREF="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link
72  * #parseRequest(HttpServletRequest)} to acquire a list of {@link
73  * org.apache.commons.fileupload.FileItem}s associated with a given HTML
74  * widget.</p>
75  *
76  * <p>How the data for individual parts is stored is determined by the factory
77  * used to create them; a given part may be in memory, on disk, or somewhere
78  * else.</p>
79  *
80  * @author <a HREF="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
81  * @author <a HREF="mailto:dlr@collab.net">Daniel Rall</a>
82  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
83  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
84  * @author <a HREF="mailto:martinc@apache.org">Martin Cooper</a>
85  * @author Sean C. Sullivan
86  *
87  * @version $Id: FileUpload.java,v 1.23 2003/06/24 05:45:43 martinc Exp $
88  */
89 public class FileUpload
90     extends FileUploadBase
91  {
92
93     // ----------------------------------------------------------- Data members
94
95
96     /**
97      * The factory to use to create new form items.
98      */
99     private FileItemFactory fileItemFactory;
100
101
102     // ----------------------------------------------------------- Constructors
103
104
105     /**
106      * Constructs an instance of this class which uses the default factory to
107      * create <code>FileItem</code> instances.
108      *
109      * @see #FileUpload(FileItemFactory)
110      */
111     public FileUpload()
112     {
113         super();
114     }
115
116
117     /**
118      * Constructs an instance of this class which uses the supplied factory to
119      * create <code>FileItem</code> instances.
120      *
121      * @see #FileUpload()
122      */
123     public FileUpload(FileItemFactory fileItemFactory)
124     {
125         super();
126         this.fileItemFactory = fileItemFactory;
127     }
128
129
130     // ----------------------------------------------------- Property accessors
131
132
133     /**
134      * Returns the factory class used when creating file items.
135      *
136      * @return The factory class for new file items.
137      */
138     public FileItemFactory getFileItemFactory()
139     {
140         return fileItemFactory;
141     }
142
143
144     /**
145      * Sets the factory class to use when creating file items.
146      *
147      * @param factory The factory class for new file items.
148      */
149     public void setFileItemFactory(FileItemFactory factory)
150     {
151         this.fileItemFactory = factory;
152     }
153
154
155 }
156
Popular Tags