01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package org.apache.tomcat.util.http.fileupload;
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.tomcat.util.http.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 467222 2006-10-24 03:17:11Z markt $
42: */
43: public class FileUpload extends FileUploadBase {
44:
45: // ----------------------------------------------------------- Data members
46:
47: /**
48: * The factory to use to create new form items.
49: */
50: private FileItemFactory fileItemFactory;
51:
52: // ----------------------------------------------------------- Constructors
53:
54: /**
55: * Constructs an instance of this class which uses the default factory to
56: * create <code>FileItem</code> instances.
57: *
58: * @see #FileUpload(FileItemFactory)
59: */
60: public FileUpload() {
61: super ();
62: }
63:
64: /**
65: * Constructs an instance of this class which uses the supplied factory to
66: * create <code>FileItem</code> instances.
67: *
68: * @see #FileUpload()
69: */
70: public FileUpload(FileItemFactory fileItemFactory) {
71: super ();
72: this .fileItemFactory = fileItemFactory;
73: }
74:
75: // ----------------------------------------------------- Property accessors
76:
77: /**
78: * Returns the factory class used when creating file items.
79: *
80: * @return The factory class for new file items.
81: */
82: public FileItemFactory getFileItemFactory() {
83: return fileItemFactory;
84: }
85:
86: /**
87: * Sets the factory class to use when creating file items.
88: *
89: * @param factory The factory class for new file items.
90: */
91: public void setFileItemFactory(FileItemFactory factory) {
92: this.fileItemFactory = factory;
93: }
94:
95: }
|