com.linecorp.armeria.server.file

Interface AggregatedHttpFile

All Superinterfaces:

HttpFile

public interface AggregatedHttpFile
extends HttpFile

An immutable variant of HttpFile which has its attributes and content readily available. Unlike HttpFile, an AggregatedHttpFile does not raise an IOException for

• readAttributes()
• readHeaders()
• HttpFile.read(Executor, ByteBufAllocator)
• aggregate(Executor)
• aggregateWithPooledObjects(Executor, ByteBufAllocator)

It also has an additional method content() which gives you an immediate access to the file's content.

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<AggregatedHttpFile>	aggregate(Executor fileReadExecutor) Converts this file into an AggregatedHttpFile.
default CompletableFuture<AggregatedHttpFile>	aggregateWithPooledObjects(Executor fileReadExecutor, io.netty.buffer.ByteBufAllocator alloc) Converts this file into an AggregatedHttpFile.
HttpData	content() Returns the content of the file.
HttpFileAttributes	readAttributes() Returns the attributes of the file.
ResponseHeaders	readHeaders() Returns the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.

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

asService, builder, builder, builder, builder, builder, nonExistent, of, of, of, of, of, ofCached, ofResource, ofResource, read

Method Detail

readAttributes

HttpFileAttributes readAttributes()

Returns the attributes of the file.

Specified by:

readAttributes in interface HttpFile

Returns:

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

readHeaders

ResponseHeaders readHeaders()

Returns the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.

Specified by:

readHeaders in interface HttpFile

Returns:

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

content

HttpData content()

Returns the content of the file.

Returns:

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

aggregate

default CompletableFuture<AggregatedHttpFile> aggregate(Executor fileReadExecutor)

Description copied from interface: HttpFile

Converts this file into an AggregatedHttpFile.

Specified by:

aggregate in interface HttpFile

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

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

Description copied from interface: HttpFile

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

Specified by:

aggregateWithPooledObjects in interface HttpFile

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.