Package com.linecorp.armeria.server.file

Class StreamingHttpFile<T extends Closeable>

java.lang.Object

com.linecorp.armeria.server.file.AbstractHttpFile

com.linecorp.armeria.server.file.StreamingHttpFile<T>

Type Parameters:

T - the type of the stream where the file content is read from, e.g. InputStream.

All Implemented Interfaces:

HttpFile

public abstract class StreamingHttpFile<T extends Closeable>
extends AbstractHttpFile

A skeletal HttpFile that simplifies the streaming of potentially large content.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamingHttpFile(@Nullable MediaType contentType, Clock clock, boolean dateEnabled, boolean lastModifiedEnabled, @Nullable BiFunction<String,HttpFileAttributes,String> entityTagFunction, HttpHeaders headers)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<AggregatedHttpFile>	aggregate(Executor fileReadExecutor)	Converts this file into an AggregatedHttpFile.
final CompletableFuture<AggregatedHttpFile>	aggregateWithPooledObjects(Executor fileReadExecutor, io.netty.buffer.ByteBufAllocator alloc)	(Advanced users only) Converts this file into an AggregatedHttpFile.
protected final HttpResponse	doRead(ResponseHeaders headers, long length, Executor fileReadExecutor, io.netty.buffer.ByteBufAllocator alloc)	Returns a new HttpResponse which streams the content of the file which follows the specified ResponseHeaders.
protected abstract T	newStream()	Opens a new stream which reads from the file.
protected abstract int	read(T src, io.netty.buffer.ByteBuf dst)	Reads the content of src into dst.

Methods inherited from class com.linecorp.armeria.server.file.AbstractHttpFile

additionalHeaders, asService, clock, contentType, generateEntityTag, isDateEnabled, isLastModifiedEnabled, pathOrUri, read, readHeaders, readHeaders

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.file.HttpFile

readAttributes

Constructor Details

StreamingHttpFile

protected StreamingHttpFile(@Nullable
 @Nullable MediaType contentType,
 Clock clock,
 boolean dateEnabled,
 boolean lastModifiedEnabled,
 @Nullable
 @Nullable BiFunction<String,HttpFileAttributes,String> entityTagFunction,
 HttpHeaders headers)

Creates a new instance.

Parameters:

contentType - the MediaType of the file which will be used as the "content-type" header value. null to disable setting the "content-type" header.

clock - the Clock which provides the current date and time

dateEnabled - whether to set the "date" header automatically

lastModifiedEnabled - whether to add the "last-modified" header automatically

entityTagFunction - the BiFunction that generates an entity tag from the file's attributes. null to disable setting the "etag" header.

headers - the additional headers to set

Method Details

doRead

protected final HttpResponse doRead(ResponseHeaders headers,
 long length,
 Executor fileReadExecutor,
 io.netty.buffer.ByteBufAllocator alloc)
                             throws IOException

Description copied from class: AbstractHttpFile

Returns a new HttpResponse which streams the content of the file which follows the specified ResponseHeaders.

Specified by:

doRead in class AbstractHttpFile

Parameters:

headers - the ResponseHeaders

length - the content length. The returned HttpResponse must stream only as many bytes as this value.

fileReadExecutor - the Executor which should be used for performing a blocking file I/O

alloc - the ByteBufAllocator which should be used for allocating an input buffer

Returns:

the HttpResponse, or null if the file does not exist.

Throws:

IOException - if failed to open the file. Note that an I/O error which occurred during content streaming will be notified via the returned HttpResponse's error notification mechanism.

aggregate

public final CompletableFuture<AggregatedHttpFile> aggregate(Executor fileReadExecutor)

Description copied from interface: HttpFile

Converts this file into an AggregatedHttpFile.

Parameters:

fileReadExecutor - the Executor which will perform the read operations against the file

Returns:

a CompletableFuture which will complete when the aggregation process is finished, or a CompletableFuture successfully completed with this, if this file is already an AggregatedHttpFile.

aggregateWithPooledObjects

public final CompletableFuture<AggregatedHttpFile> aggregateWithPooledObjects(Executor fileReadExecutor,
 io.netty.buffer.ByteBufAllocator alloc)

Description copied from interface: HttpFile

(Advanced users only) Converts this file into an AggregatedHttpFile. AggregatedHttpFile.content() will return a pooled HttpData, and the caller must ensure to release it. If you don't know what this means, use HttpFile.aggregate(Executor).

Parameters:

fileReadExecutor - the Executor which will perform the read operations against the file

alloc - the ByteBufAllocator which will allocate the content buffer

Returns:

a CompletableFuture which will complete when the aggregation process is finished, or a CompletableFuture successfully completed with this, if this file is already an AggregatedHttpFile.

See Also:

• PooledObjects

newStream

@Nullable
protected abstract T newStream()
                        throws IOException

Opens a new stream which reads from the file.

Returns:

the new stream, or null if the file does not exist.

Throws:

IOException - if failed to open a new stream

read

protected abstract int read(T src,
 io.netty.buffer.ByteBuf dst)
                     throws IOException

Reads the content of src into dst.

Returns:

the number of read bytes, or -1 if reached at the end of the file

Throws:

IOException - if failed to read the content