org.apache.commons.httpclient.methods
Class StringRequestEntity

java.lang.Object
  org.apache.commons.httpclient.methods.StringRequestEntity

All Implemented Interfaces:

RequestEntity

public class StringRequestEntity
extends Object
implements RequestEntity

A RequestEntity that contains a String.

Since:

3.0

Constructor Summary

StringRequestEntity(String content)
Creates a new entity with the given content.

StringRequestEntity(String content, String contentType, String charset)
Creates a new entity with the given content, content type, and charset.

Method Summary

String	getCharset()
String	getContent()
long	getContentLength() Gets the request entity's length.
String	getContentType() Gets the entity's content type.
boolean	isRepeatable() Tests if RequestEntity.writeRequest(OutputStream) can be called more than once.
void	writeRequest(OutputStream out) Writes the request entity to the given stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringRequestEntity

public StringRequestEntity(String content)

Creates a new entity with the given content. This constructor will use the default platform charset to convert the content string and will provide no content type.

This constructor may be deprecated or changed to use the default HTTP content charset (ISO-8859-1) in the release 3.1

It is strongly recommended to use StringRequestEntity(String, String, String) constructor instead.

Parameters:

content - The content to set.

See Also:

StringRequestEntity(String, String, String)

StringRequestEntity

public StringRequestEntity(String content,
                           String contentType,
                           String charset)
                    throws UnsupportedEncodingException

Creates a new entity with the given content, content type, and charset.

Parameters:

content - The content to set.

contentType - The type of the content, or null. The value retured by getContentType(). If this content type contains a charset and the charset parameter is null, the content's type charset will be used.

charset - The charset of the content, or null. Used to convert the content to bytes. If the content type does not contain a charset and charset is not null, then the charset will be appended to the content type.

Throws:

UnsupportedEncodingException

Method Detail

getContentType

public String getContentType()

Gets the entity's content type. This content type will be used as the value for the "Content-Type" header.

Specified by:

getContentType in interface RequestEntity

Returns:

the entity's content type

See Also:

HttpMethod.setRequestHeader(String, String)

isRepeatable

public boolean isRepeatable()

Description copied from interface: RequestEntity

Tests if RequestEntity.writeRequest(OutputStream) can be called more than once.

Specified by:

isRepeatable in interface RequestEntity

Returns:

true

writeRequest

public void writeRequest(OutputStream out)
                  throws IOException

Writes the request entity to the given stream.

Specified by:

writeRequest in interface RequestEntity

Throws:

IOException

getContentLength

public long getContentLength()

Description copied from interface: RequestEntity

Gets the request entity's length. This method should return a non-negative value if the content length is known or a negative value if it is not. In the latter case the EntityEnclosingMethod will use chunk encoding to transmit the request entity.

Specified by:

getContentLength in interface RequestEntity

Returns:

The length of the content.

getContent

public String getContent()

Returns:

Returns the content.

getCharset

public String getCharset()

Returns:

Returns the charset used to convert the content to bytes. null if no charset as been specified.