01: /*
02: * $Header: /home/cvs/jakarta-commons/fileupload/src/java/org/apache/commons/fileupload/FileItemFactory.java,v 1.1 2003/04/27 17:30:06 martinc Exp $
03: * $Revision: 1.1 $
04: * $Date: 2003/04/27 17:30:06 $
05: *
06: * ====================================================================
07: *
08: * The Apache Software License, Version 1.1
09: *
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: package de.ug2t.extTools.httpFileUpLoad;
63:
64: /**
65: * <p>
66: * A factory interface for creating {@link FileItem} instances. Factories can
67: * provide their own custom configuration, over and above that provided by the
68: * default file upload implementation.
69: * </p>
70: *
71: * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
72: *
73: * @version $Id: FileItemFactory.java,v 1.1 2003/04/27 17:30:06 martinc Exp $
74: */
75: public interface FileItemFactory {
76:
77: /**
78: * Create a new {@link FileItem} instance from the supplied parameters and any
79: * local factory configuration.
80: *
81: * @param fieldName
82: * The name of the form field.
83: * @param contentType
84: * The content type of the form field.
85: * @param isFormField
86: * <code>true</code> if this is a plain form field;
87: * <code>false</code> otherwise.
88: * @param fileName
89: * The name of the uploaded file, if any, as supplied by the browser
90: * or other client.
91: *
92: * @return The newly created file item.
93: */
94: FileItem createItem(String fieldName, String contentType,
95: boolean isFormField, String fileName);
96: }
|