Package org.apache.juneau.http.classic.resource

Class StreamResource

java.lang.Object

org.apache.juneau.http.classic.resource.BasicResource<StreamResource>

org.apache.juneau.http.classic.resource.StreamResource

All Implemented Interfaces:

HttpEntity, HttpResource

Direct Known Subclasses:

StreamResource.Unmodifiable

public class StreamResource
extends BasicResource<StreamResource>

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

See Also:

• juneau-rest-common

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamResource.Unmodifiable	An unmodifiable snapshot of a StreamResource.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StreamResource	copy()	Creates a builder for this class initialized with the contents of this bean.
StreamResource	unmodifiable()	Returns an unmodifiable snapshot of this bean.

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

addHeader, addHeaders, asBytes, assertBytes, assertString, asString, consumeContent, copyFrom, freeze, getContent, getContentEncoding, getContentLength, getContentType, getEntity, getHeaders, isChunked, isRepeatable, isStreaming, isUnmodifiable, modify, self, setCached, setChunked, setChunked, setContent, setContent, setContentEncoding, setContentEncoding, setContentLength, setContentType, setContentType, setHeader, setHeaders, setHeaders, 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. Can be null to omit an explicit Content-Type header.

contents - The entity contents. Can be null, in which case a NullPointerException is thrown when the resource's content is read.

StreamResource

protected StreamResource(StreamResource copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied. Must not be null.

StreamResource

public StreamResource(HttpResponse response)
               throws IOException

Constructor.

This is the constructor used when converting an HTTP response into a resource.

Parameters:

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

Throws:

IOException - Rethrown from HttpEntity.getContent().

Method Details

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.

Specified by:

copy in class BasicResource<StreamResource>

Returns:

A new builder bean.

unmodifiable

public StreamResource unmodifiable()

Description copied from class: BasicResource

Returns an unmodifiable snapshot of this bean.

Idempotency: if this bean is already an unmodifiable snapshot, it is returned as-is.

Specified by:

unmodifiable in class BasicResource<StreamResource>

Returns:

An unmodifiable snapshot of this bean, or this bean if it is already unmodifiable.