org.apache.tapestry5.services.assets
Interface StreamableResource

All Known Implementing Classes:

StreamableResourceImpl

public interface StreamableResource

An object, derived from a Resource, that can be streamed (ultimately, to a client web browser).

Since:

5.3

Method Summary

CompressionStatus	getCompression() Indicates if the content is compressed, or compressable.
String	getContentType() Returns the MIME content type, e.g., "image/jpeg".
String	getDescription() Describes the underlying Resource (or resources} for this streamble resource; expressly used as part of the object's toString().
long	getLastModified() Returns the time the resource was last modified, with accuracy to one second (so as to match the HTTP request/response date headers.
int	getSize() The size, in bytes, of the underlying bytestream.
InputStream	openStream() Opens the content of the resource as an input stream; the caller is responsible for closing the stream after reading it.
void	streamTo(OutputStream os) Streams the resource's content to the provided stream.

Method Detail

getDescription

String getDescription()

Describes the underlying Resource (or resources} for this streamble resource; expressly used as part of the object's toString().

getCompression

CompressionStatus getCompression()

Indicates if the content is compressed, or compressable.

getContentType

String getContentType()

Returns the MIME content type, e.g., "image/jpeg".

getSize

int getSize()

The size, in bytes, of the underlying bytestream.

streamTo

void streamTo(OutputStream os)
              throws IOException

Streams the resource's content to the provided stream. The caller is responsible for flushing or closing the output stream.

Throws:

IOException

openStream

InputStream openStream()
                       throws IOException

Opens the content of the resource as an input stream; the caller is responsible for closing the stream after reading it.

Returns:

stream of the contents of the resource

Throws:

IOException

getLastModified

long getLastModified()

Returns the time the resource was last modified, with accuracy to one second (so as to match the HTTP request/response date headers.