com.linecorp.armeria.server.file

Class AbstractHttpFile

java.lang.Object

com.linecorp.armeria.server.file.AbstractHttpFile

All Implemented Interfaces:

HttpFile

Direct Known Subclasses:

StreamingHttpFile

public abstract class AbstractHttpFile
extends Object
implements HttpFile

A skeletal HttpFile implementation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HttpService	asService() Returns an HttpService which serves the file for HEAD and GET requests.
protected Clock	clock() Returns the Clock which provides the current date and time.
protected MediaType	contentType() Returns the MediaType of the file, which will be used for setting the "content-type" header.
protected abstract 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 String	generateEntityTag(HttpFileAttributes attrs) Generates an entity tag of the file with the given attributes using the entityTagFunction which was specified with the constructor.
protected HttpHeaders	headers() Returns the immutable additional HttpHeaders which will be set when building an HttpResponse.
protected boolean	isDateEnabled() Returns whether to add the "date" header automatically.
protected boolean	isLastModifiedEnabled() Returns whether to add the "last-modified" header automatically.
protected abstract String	pathOrUri() Returns the String representation of the file path or URI, which is given to the entityTagFunction specified with the constructor.
HttpResponse	read(Executor fileReadExecutor, io.netty.buffer.ByteBufAllocator alloc) Starts to stream this file into the returned HttpResponse.
ResponseHeaders	readHeaders() Reads the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.

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

aggregate, aggregateWithPooledObjects, builder, builder, builder, builder, builder, nonExistent, of, of, of, of, of, ofCached, ofResource, ofResource, readAttributes

Constructor Detail

AbstractHttpFile

protected AbstractHttpFile(MediaType contentType,
                           Clock clock,
                           boolean dateEnabled,
                           boolean lastModifiedEnabled,
                           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 Detail

contentType

protected final MediaType contentType()

Returns the MediaType of the file, which will be used for setting the "content-type" header.

Returns:

the MediaType of the file, or null if the "content-type" header will not be set automatically.

clock

protected final Clock clock()

Returns the Clock which provides the current date and time.

pathOrUri

protected abstract String pathOrUri()

Returns the String representation of the file path or URI, which is given to the entityTagFunction specified with the constructor.

isDateEnabled

protected final boolean isDateEnabled()

Returns whether to add the "date" header automatically.

isLastModifiedEnabled

protected final boolean isLastModifiedEnabled()

Returns whether to add the "last-modified" header automatically.

headers

protected final HttpHeaders headers()

Returns the immutable additional HttpHeaders which will be set when building an HttpResponse.

generateEntityTag

protected final String generateEntityTag(HttpFileAttributes attrs)

Generates an entity tag of the file with the given attributes using the entityTagFunction which was specified with the constructor.

Returns:

the entity tag or null if entityTagFunction is null.

readHeaders

public ResponseHeaders readHeaders()
                            throws IOException

Description copied from interface: HttpFile

Reads 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.

Throws:

IOException - if failed to retrieve the attributes of this file.

read

public final HttpResponse read(Executor fileReadExecutor,
                               io.netty.buffer.ByteBufAllocator alloc)

Description copied from interface: HttpFile

Starts to stream this file into the returned HttpResponse.

Specified by:

read in interface HttpFile

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 response, or null if the file does not exist.

doRead

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

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

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.

asService

public HttpService asService()

Description copied from interface: HttpFile

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

Specified by:

asService in interface HttpFile