org.apache.juneau.http

Class BasicHttpResource

java.lang.Object

org.apache.http.entity.AbstractHttpEntity

org.apache.http.entity.BasicHttpEntity

org.apache.juneau.http.BasicHttpEntity

org.apache.juneau.http.BasicHttpResource

All Implemented Interfaces:

HttpEntity, HttpResource

public class BasicHttpResource
extends BasicHttpEntity
implements HttpResource

An extension of an HttpEntity with support for arbitrary headers. 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
BasicHttpResource(Object content) Constructor.
BasicHttpResource(Object content, ContentType contentType, ContentEncoding contentEncoding) Constructor.

Method Summary

Modifier and Type	Method and Description
BasicHttpResource	cache() Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
BasicHttpResource	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.
BasicHttpResource	chunked() Shortcut for calling AbstractHttpEntity.setChunked(boolean) with true.
BasicHttpResource	chunked(boolean value) Shortcut for calling AbstractHttpEntity.setChunked(boolean).
BasicHttpResource	contentEncoding(Header value) Shortcut for calling AbstractHttpEntity.setContentEncoding(Header).
BasicHttpResource	contentEncoding(String value) Shortcut for calling AbstractHttpEntity.setContentEncoding(String).
BasicHttpResource	contentLength(long value) Shortcut for calling BasicHttpEntity.setContentLength(long).
BasicHttpResource	contentType(Header value) Shortcut for calling AbstractHttpEntity.setContentType(Header).
BasicHttpResource	contentType(String value) Shortcut for calling AbstractHttpEntity.setContentType(String).
Header	getFirstHeader(String name) Returns the first header with the specified name as a string.
List<Header>	getHeaders() Returns the list of headers associated with this resource.
Header	getLastHeader(String name) Returns the last header with the specified name as a string.
String	getStringHeader(String name) Returns the first header with the specified name as a string.
BasicHttpResource	header(Header value) Adds an arbitrary header to this resource.
BasicHttpResource	header(String name, Object val) Adds an arbitrary header to this resource.
BasicHttpResource	headers(Header... headers) Adds an arbitrary collection of headers to this resource.
BasicHttpResource	headers(List<Header> headers) Adds an arbitrary collection of headers to this resource.
static BasicHttpResource	of(Object content) Creator.
static BasicHttpResource	of(Supplier<?> content) Creator.

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

asBytes, assertBytes, assertString, asString, getContent, getContentLength, getRawContent, isCacheable, isRepeatable, isStreaming, readBytes, unwrap, writeTo

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

Methods inherited from interface org.apache.http.HttpEntity

consumeContent, getContent, getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable, isStreaming, writeTo

Constructor Detail

BasicHttpResource

public BasicHttpResource(Object content)

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.

BasicHttpResource

public BasicHttpResource(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 BasicHttpResource 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 BasicHttpResource object.

of

public static BasicHttpResource 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 BasicHttpResource object.

header

public BasicHttpResource header(String name,
                                Object val)

Adds an arbitrary header to this resource.

Header is not added if name or value is null.

Parameters:

name - The header name.

val - The header value.

Returns:

This object (for method chaining).

header

public BasicHttpResource header(Header value)

Adds an arbitrary header to this resource.

Parameters:

value - The header.

Returns:

This object (for method chaining).

headers

public BasicHttpResource headers(List<Header> headers)

Adds an arbitrary collection of headers to this resource.

Parameters:

headers - The headers to add to this resource.

Returns:

This object (for method chaining).

headers

public BasicHttpResource headers(Header... headers)

Adds an arbitrary collection of headers to this resource.

Parameters:

headers - The headers to add to this resource.

Returns:

This object (for method chaining).

getStringHeader

public String getStringHeader(String name)

Returns the first header with the specified name as a string.

Parameters:

name - The header name.

Returns:

The header value or null if header was not found.

getFirstHeader

public Header getFirstHeader(String name)

Returns the first header with the specified name as a string.

Parameters:

name - The header name.

Returns:

The header or null if header was not found.

getLastHeader

public Header getLastHeader(String name)

Returns the last header with the specified name as a string.

Parameters:

name - The header name.

Returns:

The header or null if header was not found.

getHeaders

public List<Header> getHeaders()

Description copied from interface: HttpResource

Returns the list of headers associated with this resource.

Specified by:

getHeaders in interface HttpResource

Returns:

The list of headers associated with this resource.

cache

public BasicHttpResource cache()

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:

cache in class BasicHttpEntity

Returns:

This object (for method chaining).

cache

public BasicHttpResource cache(boolean value)

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:

cache in class BasicHttpEntity

Parameters:

value - The new value for this flag.

Returns:

This object (for method chaining).

chunked

public BasicHttpResource chunked()

Description copied from class: BasicHttpEntity

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

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

Overrides:

chunked in class BasicHttpEntity

Returns:

This object (for method chaining).

chunked

public BasicHttpResource chunked(boolean value)

Description copied from class: BasicHttpEntity

Shortcut for calling AbstractHttpEntity.setChunked(boolean).

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

Overrides:

chunked in class BasicHttpEntity

Parameters:

value - The new value for this flag.

Returns:

This object (for method chaining).

contentEncoding

public BasicHttpResource contentEncoding(String value)

Description copied from class: BasicHttpEntity

Shortcut for calling AbstractHttpEntity.setContentEncoding(String).

Overrides:

contentEncoding in class BasicHttpEntity

Parameters:

value - The new Content-Encodingnull to unset.

Returns:

This object (for method chaining).

contentEncoding

public BasicHttpResource contentEncoding(Header value)

Description copied from class: BasicHttpEntity

Shortcut for calling AbstractHttpEntity.setContentEncoding(Header).

Overrides:

contentEncoding in class BasicHttpEntity

Parameters:

value - The new Content-Encodingnull to unset.

Returns:

This object (for method chaining).

contentLength

public BasicHttpResource contentLength(long value)

Description copied from class: BasicHttpEntity

Shortcut for calling BasicHttpEntity.setContentLength(long).

Overrides:

contentLength in class BasicHttpEntity

Parameters:

value - The new Content-Length header value.

Returns:

This object (for method chaining).

contentType

public BasicHttpResource contentType(String value)

Description copied from class: BasicHttpEntity

Shortcut for calling AbstractHttpEntity.setContentType(String).

Overrides:

contentType in class BasicHttpEntity

Parameters:

value - The new Content-Typenull to unset.

Returns:

This object (for method chaining).

contentType

public BasicHttpResource contentType(Header value)

Description copied from class: BasicHttpEntity

Shortcut for calling AbstractHttpEntity.setContentType(Header).

Overrides:

contentType in class BasicHttpEntity

Parameters:

value - The new Content-Typenull to unset.

Returns:

This object (for method chaining).