Package com.linecorp.armeria.server.file

Interface AggregatedHttpFile

public interface AggregatedHttpFile

A complete HTTP file whose attributes and content are readily available.

Method Summary

Modifier and Type	Method	Description
HttpFileAttributes	attributes()	Returns the attributes of the file.
static AggregatedHttpFileBuilder	builder(HttpData data)	Returns a new AggregatedHttpFileBuilder that builds an AggregatedHttpFile from the specified HttpData.
static AggregatedHttpFileBuilder	builder(HttpData data, long lastModifiedMillis)	Returns a new AggregatedHttpFileBuilder that builds an AggregatedHttpFile from the specified HttpData and lastModifiedMillis.
HttpData	content()	Returns the content of the file.
ResponseHeaders	headers()	Returns the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.
static AggregatedHttpFile	nonExistent()	Returns an AggregatedHttpFile which represents a non-existent file.
static AggregatedHttpFile	of(HttpData data)	Creates a new AggregatedHttpFile which streams the specified HttpData.
static AggregatedHttpFile	of(HttpData data, long lastModifiedMillis)	Creates a new AggregatedHttpFile with the specified HttpData with the specified lastModifiedMillis.
default AggregatedHttpResponse	response()	Returns the AggregatedHttpResponse generated from this file.
HttpFile	toHttpFile()	Converts this file into an HttpFile.

Method Details

of

static AggregatedHttpFile of(HttpData data)

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

of

static AggregatedHttpFile of(HttpData data,
long lastModifiedMillis)

Creates a new AggregatedHttpFile with 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

nonExistent

static AggregatedHttpFile nonExistent()

Returns an AggregatedHttpFile which represents a non-existent file.

builder

static AggregatedHttpFileBuilder builder(HttpData data)

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

builder

static AggregatedHttpFileBuilder builder(HttpData data,
long lastModifiedMillis)

Returns a new AggregatedHttpFileBuilder that builds an AggregatedHttpFile 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

attributes

@Nullable
HttpFileAttributes attributes()

Returns the attributes of the file.

Returns:

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

headers

@Nullable
ResponseHeaders headers()

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

Returns:

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

response

@Nullable
default AggregatedHttpResponse response()

Returns the AggregatedHttpResponse generated from this file.

Returns:

the AggregatedHttpResponse of the file, or null if the file does not exist.

content

@Nullable
HttpData content()

Returns the content of the file.

Returns:

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

toHttpFile

HttpFile toHttpFile()

Converts this file into an HttpFile.

Returns:

the HttpFile converted from this file.