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: package org.apache.commons.fileupload;
18:
19: import java.io.IOException;
20: import java.io.InputStream;
21:
22: /**
23: * <p> This interface provides access to a file or form item that was
24: * received within a <code>multipart/form-data</code> POST request.
25: * The items contents are retrieved by calling {@link #openStream()}.</p>
26: * <p>Instances of this class are created by accessing the
27: * iterator, returned by
28: * {@link FileUploadBase#getItemIterator(RequestContext)}.</p>
29: * <p><em>Note</em>: There is an interaction between the iterator and
30: * its associated instances of {@link FileItemStream}: By invoking
31: * {@link java.util.Iterator#hasNext()} on the iterator, you discard all data,
32: * which hasn't been read so far from the previous data.</p>
33: */
34: public interface FileItemStream {
35: /**
36: * This exception is thrown, if an attempt is made to read
37: * data from the {@link InputStream}, which has been returned
38: * by {@link FileItemStream#openStream()}, after
39: * {@link java.util.Iterator#hasNext()} has been invoked on the
40: * iterator, which created the {@link FileItemStream}.
41: */
42: public static class ItemSkippedException extends IOException {
43: /**
44: * The exceptions serial version UID, which is being used
45: * when serializing an exception instance.
46: */
47: private static final long serialVersionUID = -7280778431581963740L;
48: }
49:
50: /** Creates an {@link InputStream}, which allows to read the
51: * items contents.
52: * @return The input stream, from which the items data may
53: * be read.
54: * @throws IllegalStateException The method was already invoked on
55: * this item. It is not possible to recreate the data stream.
56: * @throws IOException An I/O error occurred.
57: * @see ItemSkippedException
58: */
59: InputStream openStream() throws IOException;
60:
61: /**
62: * Returns the content type passed by the browser or <code>null</code> if
63: * not defined.
64: *
65: * @return The content type passed by the browser or <code>null</code> if
66: * not defined.
67: */
68: String getContentType();
69:
70: /**
71: * Returns the original filename in the client's filesystem, as provided by
72: * the browser (or other client software). In most cases, this will be the
73: * base file name, without path information. However, some clients, such as
74: * the Opera browser, do include path information.
75: *
76: * @return The original filename in the client's filesystem.
77: */
78: String getName();
79:
80: /**
81: * Returns the name of the field in the multipart form corresponding to
82: * this file item.
83: *
84: * @return The name of the form field.
85: */
86: String getFieldName();
87:
88: /**
89: * Determines whether or not a <code>FileItem</code> instance represents
90: * a simple form field.
91: *
92: * @return <code>true</code> if the instance represents a simple form
93: * field; <code>false</code> if it represents an uploaded file.
94: */
95: boolean isFormField();
96: }
|