Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.httpclient.HttpMethodBase
org.apache.commons.httpclient.methods.ExpectContinueMethod
org.apache.commons.httpclient.methods.EntityEnclosingMethod
public abstract class EntityEnclosingMethod
extends ExpectContinueMethod
Field Summary | |
static long |
|
static long |
|
Constructor Summary | |
| |
|
Method Summary | |
protected void |
|
protected void |
|
protected void |
|
protected byte[] |
|
protected RequestEntity | |
boolean |
|
String |
|
protected long |
|
RequestEntity | |
protected boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected boolean |
|
Methods inherited from class org.apache.commons.httpclient.methods.ExpectContinueMethod | |
addRequestHeaders , getUseExpectHeader , hasRequestContent , setUseExpectHeader |
public static final long CONTENT_LENGTH_AUTO
Deprecated. Use
InputStreamRequestEntity.CONTENT_LENGTH_AUTO
.The content length will be calculated automatically. This implies buffering of the content.
- Field Value:
- -2L
public static final long CONTENT_LENGTH_CHUNKED
Deprecated. Use
setContentChunked(boolean)
.The request will use chunked transfer encoding. Content length is not calculated and the content is not buffered.
- Field Value:
- -1L
public EntityEnclosingMethod()
No-arg constructor.
- Since:
- 2.0
public EntityEnclosingMethod(String uri)
Constructor specifying a URI.
- Parameters:
uri
- either an absolute or relative URI
- Since:
- 2.0
protected void addContentLengthRequestHeader(HttpState state, HttpConnection conn) throws IOException, HttpException
Generates Content-Length or Transfer-Encoding: Chunked request header, as long as no Content-Length request header already exists.
- Parameters:
state
- current state of http requestsconn
- the connection to use for I/O
- Throws:
HttpException
- when a recoverable error occurs
protected void addRequestHeaders(HttpState state, HttpConnection conn) throws IOException, HttpException
Populates the request headers map to with additionalheaders
to be submitted to the givenHttpConnection
. This implementation adds tt>Content-Length or Transfer-Encoding headers. Subclasses may want to override this method to to add additional headers, and may choose to invoke this implementation (via super) to add the "standard" headers.
- Overrides:
- addRequestHeaders in interface ExpectContinueMethod
- Parameters:
state
- thestate
information associated with this methodconn
- theconnection
used to execute this HTTP method
- Throws:
HttpException
- if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
- Since:
- 3.0
- See Also:
EntityEnclosingMethod
protected void clearRequestBody()
Clears the request body. This method must be overridden by sub-classes that implement alternative request content input methods.
- Since:
- 2.0beta1
protected byte[] generateRequestBody()
Generates the request body. This method must be overridden by sub-classes that implement alternative request content input methods.
- Returns:
- request body as an array of bytes. If the request content has not been set, returns null.
- Since:
- 2.0beta1
public boolean getFollowRedirects()
Entity enclosing requests cannot be redirected without user intervention according to RFC 2616.
- Specified by:
- getFollowRedirects in interface HttpMethod
- Overrides:
- getFollowRedirects in interface HttpMethodBase
- Returns:
false
.
- Since:
- 2.0
public String getRequestCharSet()
Returns the request's charset. The charset is parsed from the request entity's content type, unless the content type header has been set manually.
- Overrides:
- getRequestCharSet in interface HttpMethodBase
- Since:
- 3.0
- See Also:
RequestEntity.getContentType()
protected long getRequestContentLength()
Returns the length of the request body.
- Returns:
- number of bytes in the request body
protected boolean hasRequestContent()
Returns true if there is a request body to be sent. This method must be overridden by sub-classes that implement alternative request content input methods
- Overrides:
- hasRequestContent in interface ExpectContinueMethod
- Returns:
- boolean
- Since:
- 2.0beta1
public void recycle()
Deprecated. no longer supported and will be removed in the future version of HttpClient
Recycles the HTTP method so that it can be used again. Note that all of the instance variables will be reset once this method has been called. This method will also release the connection being used by this HTTP method.
- Specified by:
- recycle in interface HttpMethod
- Overrides:
- recycle in interface HttpMethodBase
- See Also:
releaseConnection()
public void setContentChunked(boolean chunked)
Sets whether or not the content should be chunked.
- Parameters:
chunked
-true
if the content should be chunked
- Since:
- 3.0
public void setFollowRedirects(boolean followRedirects)
Entity enclosing requests cannot be redirected without user intervention according to RFC 2616.
- Specified by:
- setFollowRedirects in interface HttpMethod
- Overrides:
- setFollowRedirects in interface HttpMethodBase
- Parameters:
followRedirects
- must always befalse
public void setRequestBody(InputStream body)
Deprecated. use
setRequestEntity(RequestEntity)
Sets the request body to be the specified inputstream.
- Parameters:
body
- Request body content asjava.io.InputStream
public void setRequestBody(String body)
Deprecated. use
setRequestEntity(RequestEntity)
Sets the request body to be the specified string. The string will be submitted, using the encoding specified in the Content-Type request header.
Example:setRequestHeader("Content-type", "text/xml; charset=UTF-8");
Would use the UTF-8 encoding. If no charset is specified, thedefault
content encoding is used (ISO-8859-1).
- Parameters:
body
- Request body content as a string
public void setRequestContentLength(int length)
Deprecated. Use
setContentChunked(boolean)
orsetRequestEntity(RequestEntity)
Sets length information about the request body. Note: If you specify a content length the request is unbuffered. This prevents redirection and automatic retry if a request fails the first time. This means that the HttpClient can not perform authorization automatically but will throw an Exception. You will have to set the necessary 'Authorization' or 'Proxy-Authorization' headers manually.
- Parameters:
length
- size in bytes or any of CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED. If number of bytes or CONTENT_LENGTH_CHUNKED is specified the content will not be buffered internally and the Content-Length header of the request will be used. In this case the user is responsible to supply the correct content length. If CONTENT_LENGTH_AUTO is specified the request will be buffered before it is sent over the network.
public void setRequestContentLength(long length)
Deprecated. Use
setContentChunked(boolean)
orsetRequestEntity(RequestEntity)
Sets length information about the request body. Note: If you specify a content length the request is unbuffered. This prevents redirection and automatic retry if a request fails the first time. This means that the HttpClient can not perform authorization automatically but will throw an Exception. You will have to set the necessary 'Authorization' or 'Proxy-Authorization' headers manually.
- Parameters:
length
- size in bytes or any of CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED. If number of bytes or CONTENT_LENGTH_CHUNKED is specified the content will not be buffered internally and the Content-Length header of the request will be used. In this case the user is responsible to supply the correct content length. If CONTENT_LENGTH_AUTO is specified the request will be buffered before it is sent over the network.
public void setRequestEntity(RequestEntity requestEntity)
- Parameters:
requestEntity
- The requestEntity to set.
- Since:
- 3.0
protected boolean writeRequestBody(HttpState state, HttpConnection conn) throws IOException, HttpException
Writes the request body to the givenconnection
.
- Overrides:
- writeRequestBody in interface HttpMethodBase
- Parameters:
state
- thestate
information associated with this methodconn
- theconnection
used to execute this HTTP method
- Returns:
- true
- Throws:
HttpException
- if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.