Package org.apache.juneau.http.entity

Class ByteArrayEntity

java.lang.Object

org.apache.juneau.http.entity.BasicHttpEntity

org.apache.juneau.http.entity.ByteArrayEntity

All Implemented Interfaces:

HttpEntity

public class ByteArrayEntity
extends BasicHttpEntity

A repeatable entity that obtains its content from a byte array.

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Modifier	Constructor	Description
	ByteArrayEntity()	Constructor.
protected	ByteArrayEntity(ByteArrayEntity copyFrom)	Copy constructor.
	ByteArrayEntity(ContentType contentType, byte[] contents)	Constructor.

Method Summary

Modifier and Type	Method	Description
byte[]	asBytes()	Converts the contents of this entity as a byte array.
String	asString()	Converts the contents of this entity as a string.
ByteArrayEntity	copy()	Creates a builder for this class initialized with the contents of this bean.
InputStream	getContent()
long	getContentLength()
boolean	isRepeatable()
ByteArrayEntity	setCached()	Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
ByteArrayEntity	setCharset(Charset value)	Specifies the charset to use when converting to and from stream-based resources.
ByteArrayEntity	setChunked()	Sets the 'chunked' flag value to true.
ByteArrayEntity	setChunked(boolean value)	Sets the 'chunked' flag value.
ByteArrayEntity	setContent(Object value)	Sets the content on this entity bean.
ByteArrayEntity	setContent(Supplier<?> value)	Sets the content on this entity bean from a supplier.
ByteArrayEntity	setContentEncoding(String value)	Sets the content encoding header on this entity bean.
ByteArrayEntity	setContentEncoding(ContentEncoding value)	Sets the content encoding header on this entity bean.
ByteArrayEntity	setContentLength(long value)	Sets the content length on this entity bean.
ByteArrayEntity	setContentType(String value)	Sets the content type on this entity bean.
ByteArrayEntity	setContentType(ContentType value)	Sets the content type on this entity bean.
ByteArrayEntity	setMaxLength(int value)	Specifies the maximum number of bytes to read or write to and from stream-based resources.
ByteArrayEntity	setUnmodifiable()	Specifies whether this bean should be unmodifiable.
void	writeTo(OutputStream out)

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

asSafeBytes, assertBytes, assertModifiable, assertString, consumeContent, contentOrElse, getCharset, getContentEncoding, getContentType, getMaxLength, isCached, isChunked, isStreaming, isSupplied, isUnmodifiable

Methods inherited from class java.lang.Object

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

Constructor Details

ByteArrayEntity

public ByteArrayEntity()

Constructor.

ByteArrayEntity

public ByteArrayEntity(ContentType contentType,
 byte[] contents)

Constructor.

Parameters:

contentType - The entity content type.

contents - The entity contents.

ByteArrayEntity

protected ByteArrayEntity(ByteArrayEntity copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied.

Method Details

copy

public ByteArrayEntity copy()

Description copied from class: BasicHttpEntity

Creates a builder for this class initialized with the contents of this bean.

Allows you to create a modifiable copy of this bean.

Overrides:

copy in class BasicHttpEntity

Returns:

A new builder bean.

asString

public String asString()
                throws IOException

Description copied from class: BasicHttpEntity

Converts the contents of this entity as a string.

Note that this may exhaust the content on non-repeatable, non-cached entities.

Overrides:

asString in class BasicHttpEntity

Returns:

The contents of this entity as a string.

Throws:

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

asBytes

public byte[] asBytes()
               throws IOException

Description copied from class: BasicHttpEntity

Converts the contents of this entity as a byte array.

Note that this may exhaust the content on non-repeatable, non-cached entities.

Overrides:

asBytes in class BasicHttpEntity

Returns:

The contents of this entity as a byte array.

Throws:

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

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()
                       throws IOException

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class BasicHttpEntity

Throws:

IOException

writeTo

public void writeTo(OutputStream out)
             throws IOException

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class BasicHttpEntity

Throws:

IOException

setCached

public ByteArrayEntity setCached()
                          throws IOException

Description copied from class: BasicHttpEntity

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

Overrides:

setCached in class BasicHttpEntity

Returns:

This object.

Throws:

IOException - If entity could not be read into memory.

setCharset

public ByteArrayEntity setCharset(Charset value)

Description copied from class: BasicHttpEntity

Specifies the charset to use when converting to and from stream-based resources.

Overrides:

setCharset in class BasicHttpEntity

Parameters:

value - The new value. If null, UTF-8 is assumed.

Returns:

This object.

setChunked

public ByteArrayEntity setChunked()

Description copied from class: BasicHttpEntity

Sets the 'chunked' flag value to true.

Notes:

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

Overrides:

setChunked in class BasicHttpEntity

Returns:

This object.

setChunked

public ByteArrayEntity setChunked(boolean value)

Description copied from class: BasicHttpEntity

Sets the 'chunked' flag value.

Notes:

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

Overrides:

setChunked in class BasicHttpEntity

Parameters:

value - The new value for this flag.

Returns:

This object.

setContent

public ByteArrayEntity setContent(Object value)

Description copied from class: BasicHttpEntity

Sets the content on this entity bean.

Overrides:

setContent in class BasicHttpEntity

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContent

public ByteArrayEntity setContent(Supplier<?> value)

Description copied from class: BasicHttpEntity

Sets the content on this entity bean from a supplier.

Repeatable entities such as StringEntity use this to allow the entity content to be resolved at serialization time.

Overrides:

setContent in class BasicHttpEntity

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContentEncoding

public ByteArrayEntity setContentEncoding(String value)

Description copied from class: BasicHttpEntity

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicHttpEntity

Parameters:

value - The new Content-Encoding header, or null to unset.

Returns:

This object.

setContentEncoding

public ByteArrayEntity setContentEncoding(ContentEncoding value)

Description copied from class: BasicHttpEntity

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicHttpEntity

Parameters:

value - The new Content-Encoding header, or null to unset.

Returns:

This object.

setContentLength

public ByteArrayEntity setContentLength(long value)

Description copied from class: BasicHttpEntity

Sets the content length on this entity bean.

Overrides:

setContentLength in class BasicHttpEntity

Parameters:

value - The new Content-Length header value, or -1 to unset.

Returns:

This object.

setContentType

public ByteArrayEntity setContentType(String value)

Description copied from class: BasicHttpEntity

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicHttpEntity

Parameters:

value - The new Content-Type header, or null to unset.

Returns:

This object.

setContentType

public ByteArrayEntity setContentType(ContentType value)

Description copied from class: BasicHttpEntity

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicHttpEntity

Parameters:

value - The new Content-Type header, or null to unset.

Returns:

This object.

setMaxLength

public ByteArrayEntity setMaxLength(int value)

Description copied from class: BasicHttpEntity

Specifies the maximum number of bytes to read or write to and from stream-based resources.

Implementation is not universal.

Overrides:

setMaxLength in class BasicHttpEntity

Parameters:

value - The new value. The default is -1 which means read everything.

Returns:

This object.

setUnmodifiable

public ByteArrayEntity setUnmodifiable()

Description copied from class: BasicHttpEntity

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Overrides:

setUnmodifiable in class BasicHttpEntity

Returns:

This object.