1 /*
2 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/RequestEntity.java,v 1.4 2004/05/17 21:46:03 olegk Exp $
3 * $Revision: 161963 $
4 * $Date: 2005-04-19 16:25:06 -0400 (Tue, 19 Apr 2005) $
5 *
6 * ====================================================================
7 *
8 * Copyright 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;
31
32 import java.io.IOException;
33 import java.io.OutputStream;
34
35 /***
36 * @since 3.0
37 */
38 public interface RequestEntity {
39
40 /***
41 * Tests if {@link #writeRequest(OutputStream)} can be called more than once.
42 *
43 * @return <tt>true</tt> if the entity can be written to {@link OutputStream} more than once,
44 * <tt>false</tt> otherwise.
45 */
46 boolean isRepeatable();
47
48 /***
49 * Writes the request entity to the given stream.
50 * @param out
51 * @throws IOException
52 */
53 void writeRequest(OutputStream out) throws IOException;
54
55 /***
56 * Gets the request entity's length. This method should return a non-negative value if the content
57 * length is known or a negative value if it is not. In the latter case the
58 * {@link org.apache.commons.httpclient.methods.EntityEnclosingMethod} will use chunk encoding to
59 * transmit the request entity.
60 *
61 * @return a non-negative value when content length is known or a negative value when content length
62 * is not known
63 */
64 long getContentLength();
65
66 /***
67 * Gets the entity's content type. This content type will be used as the value for the
68 * "Content-Type" header.
69 * @return the entity's content type
70 * @see org.apache.commons.httpclient.HttpMethod#setRequestHeader(String, String)
71 */
72 String getContentType();
73
74 }