Package org.apache.juneau.http.resource

Class BasicResource

java.lang.Object

org.apache.juneau.http.resource.BasicResource

All Implemented Interfaces:

HttpEntity, HttpResource

Direct Known Subclasses:

ByteArrayResource, FileResource, ReaderResource, StreamResource, StringResource

@BeanIgnore
public class BasicResource
extends Object
implements HttpResource

A basic HttpResource implementation with additional features. Provides the following features:

• Caching.
• Fluent setters.
• Fluent assertions.
• Externally-supplied/dynamic content.

See Also:

• juneau-rest-common Basics

Constructor Summary

Constructors

Constructor	Description
BasicResource(HttpResponse response)	Constructor.
BasicResource(BasicHttpEntity entity)	Constructor.
BasicResource(BasicResource copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
BasicResource	addHeader(String name, String value)	Appends the specified header to the end of the headers in this builder.
BasicResource	addHeaders(Header... values)	Appends the specified headers to the end of the headers in this builder.
byte[]	asBytes()	Converts the contents of the entity of this resource as a byte array.
FluentByteArrayAssertion<BasicResource>	assertBytes()	Returns an assertion on the contents of the entity of this resource.
protected final void	assertModifiable()	Throws an UnsupportedOperationException if the unmodifiable flag is set on this bean.
FluentStringAssertion<BasicResource>	assertString()	Returns an assertion on the contents of the entity of this resource.
String	asString()	Converts the contents of the entity of this resource as a string.
void	consumeContent()
BasicResource	copy()	Creates a builder for this class initialized with the contents of this bean.
BasicResource	copyFrom(HttpResponse response)	Copies the contents of the specified HTTP response to this builder.
InputStream	getContent()
Header	getContentEncoding()
long	getContentLength()
Header	getContentType()
HttpEntity	getEntity()	Returns access to the underlying builder for the HTTP entity.
HeaderList	getHeaders()	Returns the list of headers associated with this resource.
boolean	isChunked()
boolean	isRepeatable()
boolean	isStreaming()
boolean	isUnmodifiable()	Returns true if this bean is unmodifiable.
BasicResource	setCached()	Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
BasicResource	setChunked()	Sets the 'chunked' flag value to true.
BasicResource	setChunked(boolean value)	Sets the 'chunked' flag value.
BasicResource	setContent(Object value)	Sets the content on this entity bean.
BasicResource	setContent(Supplier<?> value)	Sets the content on this entity bean from a supplier.
BasicResource	setContentEncoding(String value)	Sets the content encoding header on this entity bean.
BasicResource	setContentEncoding(ContentEncoding value)	Sets the content encoding header on this entity bean.
BasicResource	setContentLength(long value)	Sets the content length on this entity bean.
BasicResource	setContentType(String value)	Sets the content type on this entity bean.
BasicResource	setContentType(ContentType value)	Sets the content type on this entity bean.
BasicResource	setHeader(String name, String value)	Sets the specified header in this builder.
BasicResource	setHeaders(Header... values)	Sets the specified headers in this builder.
BasicResource	setHeaders(HeaderList value)	Sets the specified headers in this builder.
BasicResource	setUnmodifiable()	Specifies whether this bean should be unmodifiable.
void	writeTo(OutputStream outStream)

Methods inherited from class java.lang.Object

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

Constructor Details

BasicResource

public BasicResource(BasicHttpEntity entity)

Constructor.

Parameters:

entity - The entity that makes up this resource content.

BasicResource

public BasicResource(BasicResource copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean bean copied.

BasicResource

public BasicResource(HttpResponse response)
              throws IOException

Constructor.

This is the constructor used when parsing an HTTP response.

Parameters:

response - The HTTP response to copy from. Must not be null.

Throws:

IOException - Rethrown from HttpEntity.getContent().

Method Details

copy

public BasicResource copy()

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

Allows you to create a modifiable copy of this bean.

Returns:

A new builder bean.

copyFrom

public BasicResource copyFrom(HttpResponse response)
                       throws IOException

Copies the contents of the specified HTTP response to this builder.

Parameters:

response - The response to copy from. Must not be null.

Returns:

This object.

Throws:

IOException - If content could not be retrieved.

setUnmodifiable

public BasicResource setUnmodifiable()

Specifies whether this bean should be unmodifiable.

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

Returns:

This object.

isUnmodifiable

public boolean isUnmodifiable()

Returns true if this bean is unmodifiable.

Returns:

true if this bean is unmodifiable.

assertModifiable

protected final void assertModifiable()

Throws an UnsupportedOperationException if the unmodifiable flag is set on this bean.

getEntity

public HttpEntity getEntity()

Returns access to the underlying builder for the HTTP entity.

Returns:

The underlying builder for the HTTP entity.

setContent

public BasicResource setContent(Object value)

Sets the content on this entity bean.

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContent

public BasicResource setContent(Supplier<?> value)

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.

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContentType

public BasicResource setContentType(String value)

Sets the content type on this entity bean.

Parameters:

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

Returns:

This object.

setContentType

public BasicResource setContentType(ContentType value)

Sets the content type on this entity bean.

Parameters:

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

Returns:

This object.

setContentLength

public BasicResource setContentLength(long value)

Sets the content length on this entity bean.

Parameters:

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

Returns:

This object.

setContentEncoding

public BasicResource setContentEncoding(String value)

Sets the content encoding header on this entity bean.

Parameters:

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

Returns:

This object.

setContentEncoding

public BasicResource setContentEncoding(ContentEncoding value)

Sets the content encoding header on this entity bean.

Parameters:

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

Returns:

This object.

setChunked

public BasicResource setChunked()

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.

Returns:

This object.

setChunked

public BasicResource setChunked(boolean value)

Sets the 'chunked' flag value.

Notes:

• If the HttpEntity.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.

setCached

public BasicResource setCached()
                        throws IOException

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.

Throws:

IOException - If entity could not be read into memory.

setHeader

public BasicResource setHeader(String name,
 String value)

Sets the specified header in this builder.

This is a no-op if either the name or value is null.

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

addHeader

public BasicResource addHeader(String name,
 String value)

Appends the specified header to the end of the headers in this builder.

This is a no-op if either the name or value is null.

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public BasicResource setHeaders(HeaderList value)

Sets the specified headers in this builder.

Parameters:

value - The new value.

Returns:

This object.

setHeaders

public BasicResource setHeaders(Header... values)

Sets the specified headers in this builder.

Parameters:

values - The headers to add. null values are ignored.

Returns:

This object.

addHeaders

public BasicResource addHeaders(Header... values)

Appends the specified headers to the end of the headers in this builder.

Parameters:

values - The headers to set. null headers and headers with null names or values are ignored.

Returns:

This object.

asString

public String asString()
                throws IOException

Converts the contents of the entity of this resource as a string.

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

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

Converts the contents of the entity of this resource as a byte array.

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

Returns:

The contents of this entity as a byte array.

Throws:

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

assertString

public FluentStringAssertion<BasicResource> assertString()
                                                  throws IOException

Returns an assertion on the contents of the entity of this resource.

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

Returns:

A new fluent assertion.

Throws:

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

assertBytes

public FluentByteArrayAssertion<BasicResource> assertBytes()
                                                    throws IOException

Returns an assertion on the contents of the entity of this resource.

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

Returns:

A new fluent assertion.

Throws:

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

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface HttpEntity

isRepeatable

public boolean isRepeatable()

Specified by:

isRepeatable in interface HttpEntity

isChunked

public boolean isChunked()

Specified by:

isChunked in interface HttpEntity

getContentType

public Header getContentType()

Specified by:

getContentType in interface HttpEntity

getContentEncoding

public Header getContentEncoding()

Specified by:

getContentEncoding in interface HttpEntity

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in interface HttpEntity

consumeContent

public void consumeContent()
                    throws IOException

Specified by:

consumeContent in interface HttpEntity

Throws:

IOException

getContent

public InputStream getContent()
                       throws IOException,
UnsupportedOperationException

Specified by:

getContent in interface HttpEntity

Throws:

IOException

UnsupportedOperationException

writeTo

public void writeTo(OutputStream outStream)
             throws IOException

Specified by:

writeTo in interface HttpEntity

Throws:

IOException

getHeaders

public HeaderList getHeaders()

Description copied from interface: HttpResource

Returns the list of headers associated with this resource.

Note that this typically does NOT include headers associated with HttpEntity (e.g. Content-Type, Content-Encoding, and Content-Length).

Specified by:

getHeaders in interface HttpResource

Returns:

The list of headers associated with this resource.