1 /*
2 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/multipart/PartSource.java,v 1.6 2004/04/18 23:51:37 jsdever Exp $
3 * $Revision: 155418 $
4 * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
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 */
29
30 package org.apache.commons.httpclient.methods.multipart;
31
32 import java.io.IOException;
33 import java.io.InputStream;
34
35 /***
36 * An interface for providing access to data when posting MultiPart messages.
37 *
38 * @see FilePart
39 *
40 * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a>
41 *
42 * @since 2.0
43 */
44 public interface PartSource {
45
46 /***
47 * Gets the number of bytes contained in this source.
48 *
49 * @return a value >= 0
50 */
51 long getLength();
52
53 /***
54 * Gets the name of the file this source represents.
55 *
56 * @return the fileName used for posting a MultiPart file part
57 */
58 String getFileName();
59
60 /***
61 * Gets a new InputStream for reading this source. This method can be
62 * called more than once and should therefore return a new stream every
63 * time.
64 *
65 * @return a new InputStream
66 *
67 * @throws IOException if an error occurs when creating the InputStream
68 */
69 InputStream createInputStream() throws IOException;
70
71 }