org.apache.juneau.http

Class BasicHttpEntity

java.lang.Object

org.apache.http.entity.AbstractHttpEntity

org.apache.http.entity.BasicHttpEntity

org.apache.juneau.http.BasicHttpEntity

All Implemented Interfaces:

HttpEntity

Direct Known Subclasses:

BasicHttpResource, SerializedHttpEntity

public class BasicHttpEntity
extends BasicHttpEntity

An extension of BasicHttpEntity with additional features. Provides the following features:

• Default support for various streams and readers.
• Content from Suppliers.
• Caching.
• Fluent setters.
• Fluent assertions.

Field Summary

Fields inherited from class org.apache.http.entity.AbstractHttpEntity

chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
BasicHttpEntity(Object content) Creates a new basic entity.
BasicHttpEntity(Object content, ContentType contentType, ContentEncoding contentEncoding) Constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes() Converts the contents of this entity as a byte array.
FluentByteArrayAssertion<BasicHttpEntity>	assertBytes() Returns an assertion on the contents of this entity.
FluentStringAssertion<BasicHttpEntity>	assertString() Returns an assertion on the contents of this entity.
String	asString() Converts the contents of this entity as a byte array.
BasicHttpEntity	cache() Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
BasicHttpEntity	cache(boolean value) Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
BasicHttpEntity	chunked() Shortcut for calling AbstractHttpEntity.setChunked(boolean) with true.
BasicHttpEntity	chunked(boolean value) Shortcut for calling AbstractHttpEntity.setChunked(boolean).
BasicHttpEntity	contentEncoding(Header value) Shortcut for calling AbstractHttpEntity.setContentEncoding(Header).
BasicHttpEntity	contentEncoding(String value) Shortcut for calling AbstractHttpEntity.setContentEncoding(String).
BasicHttpEntity	contentLength(long value) Shortcut for calling BasicHttpEntity.setContentLength(long).
BasicHttpEntity	contentType(Header value) Shortcut for calling AbstractHttpEntity.setContentType(Header).
BasicHttpEntity	contentType(String value) Shortcut for calling AbstractHttpEntity.setContentType(String).
InputStream	getContent()
long	getContentLength()
protected Object	getRawContent() Returns the raw content of this resource.
protected boolean	isCacheable(Object o) Returns true if the specified object is cachable as a byte array.
boolean	isRepeatable()
boolean	isStreaming()
static BasicHttpEntity	of(Object content) Creator.
static BasicHttpEntity	of(Supplier<?> content) Creator.
protected byte[]	readBytes(Object o) Reads the contents of the specified object as a byte array.
protected Object	unwrap(Object o) If the specified object is a Supplier, returns the supplied value, otherwise the same value.
void	writeTo(OutputStream os)

Methods inherited from class org.apache.http.entity.BasicHttpEntity

setContent, setContentLength

Methods inherited from class org.apache.http.entity.AbstractHttpEntity

consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHttpEntity

public BasicHttpEntity(Object content)

Creates a new basic entity.

Parameters:

content - The content.
Can be any of the following:

• InputStream
• Reader - Converted to UTF-8 bytes.
• File
• CharSequence - Converted to UTF-8 bytes.
• byte[].
• A Supplier of anything on this list.

BasicHttpEntity

public BasicHttpEntity(Object content,
                       ContentType contentType,
                       ContentEncoding contentEncoding)

Constructor.

Parameters:

content - The content.
Can be any of the following:

• InputStream
• Reader - Converted to UTF-8 bytes.
• File
• CharSequence - Converted to UTF-8 bytes.
• byte[].
• A Supplier of anything on this list.

contentType - The content type of the contents.
Can be null.

contentEncoding - The content encoding of the contents.
Can be null.

Method Detail

of

public static BasicHttpEntity of(Object content)

Creator.

Parameters:

content - The content.
Can be any of the following:

• InputStream
• Reader - Converted to UTF-8 bytes.
• File
• CharSequence - Converted to UTF-8 bytes.
• byte[].
• A Supplier of anything on this list.

Returns:

A new empty BasicHttpEntity object.

of

public static BasicHttpEntity of(Supplier<?> content)

Creator.

Parameters:

content - The content.
Can be any of the following:

• InputStream
• Reader - Converted to UTF-8 bytes.
• File
• CharSequence - Converted to UTF-8 bytes.
• byte[].
• A Supplier of anything on this list.

Returns:

A new empty BasicHttpEntity object.

contentType

public BasicHttpEntity contentType(String value)

Shortcut for calling AbstractHttpEntity.setContentType(String).

Parameters:

value - The new Content-Typenull to unset.

Returns:

This object (for method chaining).

contentType

public BasicHttpEntity contentType(Header value)

Shortcut for calling AbstractHttpEntity.setContentType(Header).

Parameters:

value - The new Content-Typenull to unset.

Returns:

This object (for method chaining).

contentLength

public BasicHttpEntity contentLength(long value)

Shortcut for calling BasicHttpEntity.setContentLength(long).

Parameters:

value - The new Content-Length header value.

Returns:

This object (for method chaining).

contentEncoding

public BasicHttpEntity contentEncoding(String value)

Shortcut for calling AbstractHttpEntity.setContentEncoding(String).

Parameters:

value - The new Content-Encodingnull to unset.

Returns:

This object (for method chaining).

contentEncoding

public BasicHttpEntity contentEncoding(Header value)

Shortcut for calling AbstractHttpEntity.setContentEncoding(Header).

Parameters:

value - The new Content-Encodingnull to unset.

Returns:

This object (for method chaining).

chunked

public BasicHttpEntity chunked()

Shortcut for calling AbstractHttpEntity.setChunked(boolean) with true.

• If the getContentLength() method returns a negative value, the HttpClient code will always use chunked encoding.

Returns:

This object (for method chaining).

chunked

public BasicHttpEntity chunked(boolean value)

Shortcut for calling AbstractHttpEntity.setChunked(boolean).

• If the getContentLength() method returns a negative value, the HttpClient code will always use chunked encoding.

Parameters:

value - The new value for this flag.

Returns:

This object (for method chaining).

cache

public BasicHttpEntity cache()

Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.

Returns:

This object (for method chaining).

cache

public BasicHttpEntity cache(boolean value)

Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.

Parameters:

value - The new value for this flag.

Returns:

This object (for method chaining).

asString

public String asString()
                throws IOException

Converts the contents of this entity as a byte array.

Returns:

The contents of this entity as a byte array.

Throws:

IOException - If a problem occurred while trying to read the byte array.

asBytes

public byte[] asBytes()
               throws IOException

Converts the contents of this entity as a byte array.

Returns:

The contents of this entity as a byte array.

Throws:

IOException - If a problem occurred while trying to read the byte array.

assertString

public FluentStringAssertion<BasicHttpEntity> assertString()
                                                    throws IOException

Returns an assertion on the contents of this entity.

Returns:

A new fluent assertion.

Throws:

IOException - If a problem occurred while trying to read the byte array.

assertBytes

public FluentByteArrayAssertion<BasicHttpEntity> assertBytes()
                                                      throws IOException

Returns an assertion on the contents of this entity.

Returns:

A new fluent assertion.

Throws:

IOException - If a problem occurred while trying to read the byte array.

isRepeatable

public boolean isRepeatable()

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class BasicHttpEntity

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface HttpEntity

Overrides:

getContentLength in class BasicHttpEntity

getContent

public InputStream getContent()

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class BasicHttpEntity

writeTo

public void writeTo(OutputStream os)
             throws IOException

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class BasicHttpEntity

Throws:

IOException

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in interface HttpEntity

Overrides:

isStreaming in class BasicHttpEntity

getRawContent

protected Object getRawContent()

Returns the raw content of this resource.

Returns:

The raw content of this resource.

isCacheable

protected boolean isCacheable(Object o)

Returns true if the specified object is cachable as a byte array.

The default implementation returns true for the following types:

• File
• InputStream
• Reader

Parameters:

o - The object to check.

Returns:

true if the specified object is cachable as a byte array.

readBytes

protected byte[] readBytes(Object o)
                    throws IOException

Reads the contents of the specified object as a byte array.

Parameters:

o - The object to read.

Returns:

The byte array contents.

Throws:

IOException - If object could not be read.

unwrap

protected Object unwrap(Object o)

If the specified object is a Supplier, returns the supplied value, otherwise the same value.

Parameters:

o - The object to unwrap.

Returns:

The unwrapped object.