1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/PartSource.java,v 1.4.2.1 2004/02/22 18:21:15 olegk Exp $
3 * $Revision: 1.4.2.1 $
4 * $Date: 2004/02/22 18:21:15 $
5 *
6 * ====================================================================
7 *
8 * Copyright 1999-2004 The Apache Software Foundation
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License");
11 * you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 * ====================================================================
22 *
23 * This software consists of voluntary contributions made by many
24 * individuals on behalf of the Apache Software Foundation. For more
25 * information on the Apache Software Foundation, please see
26 * <http://www.apache.org/>.
27 *
28 * [Additional notices, if required by prior licensing conditions]
29 *
30 */
31
32 package org.apache.commons.httpclient.methods.multipart;
33
34 import java.io.IOException;
35 import java.io.InputStream;
36
37 /***
38 * An interface for providing access to data when posting MultiPart messages.
39 *
40 * @see FilePart
41 *
42 * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a>
43 *
44 * @since 2.0
45 */
46 public interface PartSource {
47
48 /***
49 * Gets the number of bytes contained in this source.
50 *
51 * @return a value >= 0
52 */
53 long getLength();
54
55 /***
56 * Gets the name of the file this source represents.
57 *
58 * @return the fileName used for posting a MultiPart file part
59 */
60 String getFileName();
61
62 /***
63 * Gets a new InputStream for reading this source. This method can be
64 * called more than once and should therefore return a new stream every
65 * time.
66 *
67 * @return a new InputStream
68 *
69 * @throws IOException if an error occurs when creating the InputStream
70 */
71 InputStream createInputStream() throws IOException;
72
73 }