KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > jforum > util > legacy > commons > fileupload > FileUpload


1 /*
2  * Copyright 2001-2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package net.jforum.util.legacy.commons.fileupload;
17
18 import javax.servlet.http.HttpServletRequest JavaDoc;
19
20 /**
21  * <p>High level API for processing file uploads.</p>
22  *
23  * <p>This class handles multiple files per single HTML widget, sent using
24  * <code>multipart/mixed</code> encoding type, as specified by
25  * <a HREF="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link
26  * #parseRequest(HttpServletRequest)} to acquire a list of {@link
27  * org.apache.commons.fileupload.FileItem}s associated with a given HTML
28  * widget.</p>
29  *
30  * <p>How the data for individual parts is stored is determined by the factory
31  * used to create them; a given part may be in memory, on disk, or somewhere
32  * else.</p>
33  *
34  * @author <a HREF="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
35  * @author <a HREF="mailto:dlr@collab.net">Daniel Rall</a>
36  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
37  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
38  * @author <a HREF="mailto:martinc@apache.org">Martin Cooper</a>
39  * @author Sean C. Sullivan
40  *
41  * @version $Id: FileUpload.java,v 1.4 2005/07/26 04:01:16 diegopires Exp $
42  */
43 public class FileUpload
44     extends FileUploadBase {
45
46     // ----------------------------------------------------------- Data members
47
48
49     /**
50      * The factory to use to create new form items.
51      */
52     private FileItemFactory fileItemFactory;
53
54
55     // ----------------------------------------------------------- Constructors
56
57
58     /**
59      * Constructs an uninitialised instance of this class. A factory must be
60      * configured, using <code>setFileItemFactory()</code>, before attempting
61      * to parse requests.
62      *
63      * @see #FileUpload(FileItemFactory)
64      */
65     public FileUpload() {
66         super();
67     }
68
69
70     /**
71      * Constructs an instance of this class which uses the supplied factory to
72      * create <code>FileItem</code> instances.
73      *
74      * @see #FileUpload()
75      */
76     public FileUpload(FileItemFactory fileItemFactory) {
77         super();
78         this.fileItemFactory = fileItemFactory;
79     }
80
81
82     // ----------------------------------------------------- Property accessors
83
84
85     /**
86      * Returns the factory class used when creating file items.
87      *
88      * @return The factory class for new file items.
89      */
90     public FileItemFactory getFileItemFactory() {
91         return fileItemFactory;
92     }
93
94
95     /**
96      * Sets the factory class to use when creating file items.
97      *
98      * @param factory The factory class for new file items.
99      */
100     public void setFileItemFactory(FileItemFactory factory) {
101         this.fileItemFactory = factory;
102     }
103
104
105 }
106
Popular Tags