1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * 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 extends FileItemHeadersSupport { 35 36 /** 37 * This exception is thrown, if an attempt is made to read 38 * data from the {@link InputStream}, which has been returned 39 * by {@link FileItemStream#openStream()}, after 40 * {@link java.util.Iterator#hasNext()} has been invoked on the 41 * iterator, which created the {@link FileItemStream}. 42 */ 43 class ItemSkippedException extends IOException { 44 45 /** 46 * The exceptions serial version UID, which is being used 47 * when serializing an exception instance. 48 */ 49 private static final long serialVersionUID = -7280778431581963740L; 50 51 } 52 53 /** 54 * Creates an {@link InputStream}, which allows to read the 55 * items contents. 56 * 57 * @return The input stream, from which the items data may 58 * be read. 59 * @throws IllegalStateException The method was already invoked on 60 * this item. It is not possible to recreate the data stream. 61 * @throws IOException An I/O error occurred. 62 * @see ItemSkippedException 63 */ 64 InputStream openStream() throws IOException; 65 66 /** 67 * Returns the content type passed by the browser or <code>null</code> if 68 * not defined. 69 * 70 * @return The content type passed by the browser or <code>null</code> if 71 * not defined. 72 */ 73 String getContentType(); 74 75 /** 76 * Returns the original filename in the client's filesystem, as provided by 77 * the browser (or other client software). In most cases, this will be the 78 * base file name, without path information. However, some clients, such as 79 * the Opera browser, do include path information. 80 * 81 * @return The original filename in the client's filesystem. 82 */ 83 String getName(); 84 85 /** 86 * Returns the name of the field in the multipart form corresponding to 87 * this file item. 88 * 89 * @return The name of the form field. 90 */ 91 String getFieldName(); 92 93 /** 94 * Determines whether or not a <code>FileItem</code> instance represents 95 * a simple form field. 96 * 97 * @return <code>true</code> if the instance represents a simple form 98 * field; <code>false</code> if it represents an uploaded file. 99 */ 100 boolean isFormField(); 101 102 }