Package com.linecorp.armeria.server.file

Interface HttpFile

All Known Implementing Classes:

AbstractHttpFile, StreamingHttpFile

public interface HttpFile

A file-like HTTP resource which yields an HttpResponse.

 HttpFile faviconFile = HttpFile.of(new File("/var/www/favicon.ico"));
 ServerBuilder builder = Server.builder();
 builder.service("/favicon.ico", faviconFile.asService());
 Server server = builder.build();
 

See Also:

HttpFileBuilder

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AggregatedHttpFile>	aggregate(Executor fileReadExecutor)	Converts this file into an AggregatedHttpFile.
CompletableFuture<AggregatedHttpFile>	aggregateWithPooledObjects(Executor fileReadExecutor, ByteBufAllocator alloc)	(Advanced users only) Converts this file into an AggregatedHttpFile.
HttpService	asService()	Returns an HttpService which serves the file for HEAD and GET requests.
static HttpFileBuilder	builder(HttpData data)	Returns a new HttpFileBuilder that builds an HttpFile from the specified HttpData.
static HttpFileBuilder	builder(HttpData data, long lastModifiedMillis)	Returns a new HttpFileBuilder that builds an HttpFile from the specified HttpData and lastModifiedMillis.
static HttpFileBuilder	builder(File file)	Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified File.
static HttpFileBuilder	builder(ClassLoader classLoader, String path)	Returns a new HttpFileBuilder that builds an HttpFile from the classpath resource at the specified path using the specified ClassLoader.
static HttpFileBuilder	builder(Path path)	Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified Path.
static HttpFile	from(CompletionStage<? extends HttpFile> stage)	Returns an HttpFile that becomes readable when the specified CompletionStage is complete.
static HttpFile	nonExistent()	Returns an HttpFile which represents a non-existent file.
static HttpFile	of(HttpData data)	Creates a new HttpFile which streams the specified HttpData.
static HttpFile	of(HttpData data, long lastModifiedMillis)	Creates a new HttpFile which streams the specified HttpData with the specified lastModifiedMillis.
static HttpFile	of(File file)	Creates a new HttpFile which streams the specified File.
static HttpFile	of(ClassLoader classLoader, String path)	Creates a new HttpFile which streams the resource at the specified path, loaded by the specified ClassLoader.
static HttpFile	of(Path path)	Creates a new HttpFile which streams the file at the specified Path.
static HttpFile	ofCached(HttpFile file, int maxCachingLength)	Creates a new HttpFile which caches the content and attributes of the specified HttpFile.
CompletableFuture<@Nullable HttpResponse>	read(Executor fileReadExecutor, ByteBufAllocator alloc)	Starts to stream this file into the returned HttpResponse.
CompletableFuture<@Nullable HttpFileAttributes>	readAttributes(Executor fileReadExecutor)	Retrieves the attributes of this file.
CompletableFuture<@Nullable ResponseHeaders>	readHeaders(Executor fileReadExecutor)	Reads the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.

Method Details

of

static HttpFile of(File file)

Creates a new HttpFile which streams the specified File.

of

static HttpFile of(Path path)

Creates a new HttpFile which streams the file at the specified Path.

of

static HttpFile of(ClassLoader classLoader,
 String path)

Creates a new HttpFile which streams the resource at the specified path, loaded by the specified ClassLoader.

Parameters:

classLoader - the ClassLoader which will load the resource at the path

path - the path to the resource

of

static HttpFile of(HttpData data)

Creates a new HttpFile which streams the specified HttpData. This method is a shortcut for HttpFile.of(data, System.currentTimeMillis().

of

static HttpFile of(HttpData data,
 long lastModifiedMillis)

Creates a new HttpFile which streams the specified HttpData with the specified lastModifiedMillis.

Parameters:

data - the data that provides the content of an HTTP response

lastModifiedMillis - when the data has been last modified, represented as the number of millisecond since the epoch

ofCached

static HttpFile ofCached(HttpFile file,
 int maxCachingLength)

Creates a new HttpFile which caches the content and attributes of the specified HttpFile. The cache is automatically invalidated when the HttpFile is updated.

Parameters:

file - the HttpFile to cache

maxCachingLength - the maximum allowed length of the HttpFile to cache. if the length of the HttpFile exceeds this value, no caching will be performed.

nonExistent

static HttpFile nonExistent()

Returns an HttpFile which represents a non-existent file.

from

static HttpFile from(CompletionStage<? extends HttpFile> stage)

Returns an HttpFile that becomes readable when the specified CompletionStage is complete. All HttpFile operations will wait until the specified CompletionStage is completed.

builder

static HttpFileBuilder builder(File file)

Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified File.

builder

static HttpFileBuilder builder(Path path)

Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified Path.

builder

static HttpFileBuilder builder(HttpData data)

Returns a new HttpFileBuilder that builds an HttpFile from the specified HttpData. The last modified date of the file is set to 'now'.

builder

static HttpFileBuilder builder(HttpData data,
 long lastModifiedMillis)

Returns a new HttpFileBuilder that builds an HttpFile from the specified HttpData and lastModifiedMillis.

Parameters:

data - the content of the file

lastModifiedMillis - the last modified time represented as the number of milliseconds since the epoch

builder

static HttpFileBuilder builder(ClassLoader classLoader,
 String path)

Returns a new HttpFileBuilder that builds an HttpFile from the classpath resource at the specified path using the specified ClassLoader.

readAttributes

CompletableFuture<@Nullable HttpFileAttributes> readAttributes(Executor fileReadExecutor)

Retrieves the attributes of this file.

Parameters:

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

Returns:

the CompletableFuture that will be completed with the attributes of this file. It will be completed with null if the file does not exist.

readHeaders

CompletableFuture<@Nullable ResponseHeaders> readHeaders(Executor fileReadExecutor)

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

Parameters:

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

Returns:

the CompletableFuture that will be completed with the headers. It will be completed with null if the file does not exist.

read

CompletableFuture<@Nullable HttpResponse> read(Executor fileReadExecutor,
 ByteBufAllocator alloc)

Starts to stream this file into the returned HttpResponse.

Parameters:

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

alloc - the ByteBufAllocator which will allocate the buffers that hold the content of the file

Returns:

the CompletableFuture that will be completed with the response. It will be completed with null if the file does not exist.

aggregate

CompletableFuture<AggregatedHttpFile> aggregate(Executor fileReadExecutor)

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

@UnstableApi
CompletableFuture<AggregatedHttpFile> aggregateWithPooledObjects(Executor fileReadExecutor,
 ByteBufAllocator alloc)

(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 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

asService

HttpService asService()

Returns an HttpService which serves the file for HEAD and GET requests.