Package org.apache.juneau.http.resource

Class StreamResource

java.lang.Object

org.apache.juneau.http.resource.BasicResource

org.apache.juneau.http.resource.StreamResource

All Implemented Interfaces:

HttpEntity, HttpResource

public class StreamResource
extends BasicResource

A streamed, non-repeatable resource that obtains its content from an InputStream.

See Also:

• juneau-rest-common Basics

Constructor Summary

Constructors

Modifier	Constructor	Description
	StreamResource()	Constructor.
	StreamResource(ContentType contentType, InputStream contents)	Constructor.
protected	StreamResource(StreamResource copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
StreamResource	addHeader(String name, String value)	Appends the specified header to the end of the headers in this builder.
StreamResource	addHeaders(Header... values)	Appends the specified headers to the end of the headers in this builder.
StreamResource	copy()	Creates a builder for this class initialized with the contents of this bean.
StreamResource	setCached()	Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
StreamResource	setChunked()	Sets the 'chunked' flag value to true.
StreamResource	setChunked(boolean value)	Sets the 'chunked' flag value.
StreamResource	setContent(Object value)	Sets the content on this entity bean.
StreamResource	setContent(Supplier<?> value)	Sets the content on this entity bean from a supplier.
StreamResource	setContentEncoding(String value)	Sets the content encoding header on this entity bean.
StreamResource	setContentEncoding(ContentEncoding value)	Sets the content encoding header on this entity bean.
StreamResource	setContentLength(long value)	Sets the content length on this entity bean.
StreamResource	setContentType(String value)	Sets the content type on this entity bean.
StreamResource	setContentType(ContentType value)	Sets the content type on this entity bean.
StreamResource	setHeader(String name, String value)	Sets the specified header in this builder.
StreamResource	setHeaders(Header... values)	Sets the specified headers in this builder.
StreamResource	setHeaders(HeaderList value)	Sets the specified headers in this builder.
StreamResource	setUnmodifiable()	Specifies whether this bean should be unmodifiable.

Methods inherited from class org.apache.juneau.http.resource.BasicResource

asBytes, assertBytes, assertModifiable, assertString, asString, consumeContent, copyFrom, getContent, getContentEncoding, getContentLength, getContentType, getEntity, getHeaders, isChunked, isRepeatable, isStreaming, isUnmodifiable, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

StreamResource

public StreamResource()

Constructor.

StreamResource

public StreamResource(ContentType contentType,
 InputStream contents)

Constructor.

Parameters:

contentType - The entity content type.

contents - The entity contents.

StreamResource

protected StreamResource(StreamResource copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied.

Method Details

addHeader

public StreamResource addHeader(String name,
 String value)

Description copied from class: BasicResource

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.

Overrides:

addHeader in class BasicResource

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

addHeaders

public StreamResource addHeaders(Header... values)

Description copied from class: BasicResource

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

Overrides:

addHeaders in class BasicResource

Parameters:

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

Returns:

This object.

copy

public StreamResource copy()

Description copied from class: BasicResource

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 BasicResource

Returns:

A new builder bean.

setCached

public StreamResource setCached()
                         throws IOException

Description copied from class: BasicResource

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 BasicResource

Returns:

This object.

Throws:

IOException - If entity could not be read into memory.

setChunked

public StreamResource setChunked()

Description copied from class: BasicResource

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 BasicResource

Returns:

This object.

setChunked

public StreamResource setChunked(boolean value)

Description copied from class: BasicResource

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 BasicResource

Parameters:

value - The new value for this flag.

Returns:

This object.

setContent

public StreamResource setContent(Object value)

Description copied from class: BasicResource

Sets the content on this entity bean.

Overrides:

setContent in class BasicResource

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContent

public StreamResource setContent(Supplier<?> value)

Description copied from class: BasicResource

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 BasicResource

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContentEncoding

public StreamResource setContentEncoding(ContentEncoding value)

Description copied from class: BasicResource

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicResource

Parameters:

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

Returns:

This object.

setContentEncoding

public StreamResource setContentEncoding(String value)

Description copied from class: BasicResource

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicResource

Parameters:

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

Returns:

This object.

setContentLength

public StreamResource setContentLength(long value)

Description copied from class: BasicResource

Sets the content length on this entity bean.

Overrides:

setContentLength in class BasicResource

Parameters:

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

Returns:

This object.

setContentType

public StreamResource setContentType(ContentType value)

Description copied from class: BasicResource

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicResource

Parameters:

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

Returns:

This object.

setContentType

public StreamResource setContentType(String value)

Description copied from class: BasicResource

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicResource

Parameters:

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

Returns:

This object.

setHeader

public StreamResource setHeader(String name,
 String value)

Description copied from class: BasicResource

Sets the specified header in this builder.

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

Overrides:

setHeader in class BasicResource

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public StreamResource setHeaders(Header... values)

Description copied from class: BasicResource

Sets the specified headers in this builder.

Overrides:

setHeaders in class BasicResource

Parameters:

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

Returns:

This object.

setHeaders

public StreamResource setHeaders(HeaderList value)

Description copied from class: BasicResource

Sets the specified headers in this builder.

Overrides:

setHeaders in class BasicResource

Parameters:

value - The new value.

Returns:

This object.

setUnmodifiable

public StreamResource setUnmodifiable()

Description copied from class: BasicResource

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 BasicResource

Returns:

This object.