Package org.apache.juneau.http.entity

Class SerializedEntity

java.lang.Object

org.apache.juneau.http.entity.BasicHttpEntity

org.apache.juneau.http.entity.SerializedEntity

All Implemented Interfaces:

HttpEntity

public class SerializedEntity
extends BasicHttpEntity

HttpEntity for serializing POJOs as the body of HTTP requests.

See Also:

• juneau-rest-common Basics

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SerializedEntity()	Constructor.
SerializedEntity(SerializedEntity copyFrom)	Copy constructor.
SerializedEntity(ContentType contentType, Object content, Serializer serializer, HttpPartSchema schema)	Constructor.

Method Summary

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

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

asBytes, asSafeBytes, assertBytes, assertModifiable, assertString, asString, consumeContent, contentOrElse, getCharset, getContentEncoding, 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

SerializedEntity

public SerializedEntity()

Constructor.

SerializedEntity

public SerializedEntity(ContentType contentType,
 Object content,
 Serializer serializer,
 HttpPartSchema schema)

Constructor.

Parameters:

contentType - The entity content type.

content - The entity content.

serializer - The entity serializer.

schema - The entity schema. Can be null.

SerializedEntity

public SerializedEntity(SerializedEntity copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied.

Method Details

copy

public SerializedEntity copy()

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.

copyWith

public SerializedEntity copyWith(Serializer serializer,
 HttpPartSchema schema)

Copies this bean and sets the serializer and schema on it.

Parameters:

serializer - The new serializer for the bean. Can be null.

schema - The new schema for the bean. Can be null.

Returns:

Either a new bean with the serializer set, or this bean if both values are null or the serializer and schema were already set.

setSerializer

public SerializedEntity setSerializer(Serializer value)

Sets the serializer on this entity bean.

Parameters:

value - The entity serializer, can be null.

Returns:

This object.

setSchema

public SerializedEntity setSchema(HttpPartSchema value)

Sets the schema on this entity bean.

Used to provide instructions to the serializer on how to serialize this object.

Parameters:

value - The entity schema, can be null.

Returns:

This object.

getContentType

public Header getContentType()

Specified by:

getContentType in interface HttpEntity

Overrides:

getContentType in class BasicHttpEntity

writeTo

public void writeTo(OutputStream os)
             throws IOException

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class BasicHttpEntity

Throws:

IOException

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

setCached

public SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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 SerializedEntity 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.