Package com.linecorp.armeria.server.file

Class AggregatedHttpFileBuilder

java.lang.Object

com.linecorp.armeria.server.file.AbstractHttpFileBuilder

com.linecorp.armeria.server.file.AggregatedHttpFileBuilder

public final class AggregatedHttpFileBuilder
extends AbstractHttpFileBuilder

Builds an AggregatedHttpFile from an HttpData.

 AggregatedHttpFile f =
         AggregatedHttpFile.builder(HttpData.ofUtf8("content"), System.currentTimeMillis())
                           .entityTag((pathOrUri, attrs) -> "myCustomEntityTag")
                           .build();
 

Method Summary

Modifier and Type	Method	Description
AggregatedHttpFileBuilder	addHeader(CharSequence name, Object value)	Adds the specified HTTP header.
AggregatedHttpFileBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Adds the specified HTTP headers.
AggregatedHttpFileBuilder	autoDetectedContentType(boolean contentTypeAutoDetectionEnabled)	Sets whether to set the "content-type" header automatically based on the extension of the file.
AggregatedHttpFile	build()	Returns a newly created AggregatedHttpFile with the properties configured so far.
AggregatedHttpFileBuilder	cacheControl(CacheControl cacheControl)	Sets the "cache-control" header.
AggregatedHttpFileBuilder	cacheControl(CharSequence cacheControl)	Sets the "cache-control" header.
AggregatedHttpFileBuilder	clock(Clock clock)	Sets the Clock that provides the current date and time.
AggregatedHttpFileBuilder	contentType(MediaType contentType)	Sets the "content-type" header.
AggregatedHttpFileBuilder	contentType(CharSequence contentType)	Sets the "content-type" header.
AggregatedHttpFileBuilder	date(boolean dateEnabled)	Sets whether to set the "date" header automatically.
AggregatedHttpFileBuilder	entityTag(boolean enabled)	Sets whether to set the "etag" header automatically based on the path and attributes of the file.
AggregatedHttpFileBuilder	entityTag(BiFunction<String,HttpFileAttributes,String> entityTagFunction)	Sets the function which generates the entity tag that's used for setting the "etag" header automatically.
AggregatedHttpFileBuilder	lastModified(boolean lastModifiedEnabled)	Sets whether to set the "last-modified" header automatically.
AggregatedHttpFileBuilder	setHeader(CharSequence name, Object value)	Sets the specified HTTP header.
AggregatedHttpFileBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Sets the specified HTTP headers.

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

buildHeaders, clock, entityTagFunction, isContentTypeAutoDetectionEnabled, isDateEnabled, isLastModifiedEnabled

Methods inherited from class java.lang.Object

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

Method Details

build

public AggregatedHttpFile build()

Returns a newly created AggregatedHttpFile with the properties configured so far.

clock

public AggregatedHttpFileBuilder clock(Clock clock)

Description copied from class: AbstractHttpFileBuilder

Sets the Clock that provides the current date and time. By default, Clock.systemUTC() is used.

Overrides:

clock in class AbstractHttpFileBuilder

date

public AggregatedHttpFileBuilder date(boolean dateEnabled)

Description copied from class: AbstractHttpFileBuilder

Sets whether to set the "date" header automatically. By default, the "date" header is set automatically.

Overrides:

date in class AbstractHttpFileBuilder

lastModified

public AggregatedHttpFileBuilder lastModified(boolean lastModifiedEnabled)

Description copied from class: AbstractHttpFileBuilder

Sets whether to set the "last-modified" header automatically. By default, the "last-modified" is set automatically.

Overrides:

lastModified in class AbstractHttpFileBuilder

autoDetectedContentType

public AggregatedHttpFileBuilder autoDetectedContentType(boolean contentTypeAutoDetectionEnabled)

Description copied from class: AbstractHttpFileBuilder

Sets whether to set the "content-type" header automatically based on the extension of the file. By default, the "content-type" header is set automatically.

Overrides:

autoDetectedContentType in class AbstractHttpFileBuilder

entityTag

public AggregatedHttpFileBuilder entityTag(boolean enabled)

Description copied from class: AbstractHttpFileBuilder

Sets whether to set the "etag" header automatically based on the path and attributes of the file. By default, the "etag" header is set automatically. Use AbstractHttpFileBuilder.entityTag(BiFunction) to customize how an entity tag is generated.

Overrides:

entityTag in class AbstractHttpFileBuilder

entityTag

public AggregatedHttpFileBuilder entityTag(BiFunction<String,HttpFileAttributes,String> entityTagFunction)

Description copied from class: AbstractHttpFileBuilder

Sets the function which generates the entity tag that's used for setting the "etag" header automatically.

Overrides:

entityTag in class AbstractHttpFileBuilder

Parameters:

entityTagFunction - the entity tag function that generates the entity tag, or null to disable setting the "etag" header.

addHeader

public AggregatedHttpFileBuilder addHeader(CharSequence name,
 Object value)

Description copied from class: AbstractHttpFileBuilder

Adds the specified HTTP header.

Overrides:

addHeader in class AbstractHttpFileBuilder

addHeaders

public AggregatedHttpFileBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from class: AbstractHttpFileBuilder

Adds the specified HTTP headers.

Overrides:

addHeaders in class AbstractHttpFileBuilder

setHeader

public AggregatedHttpFileBuilder setHeader(CharSequence name,
 Object value)

Description copied from class: AbstractHttpFileBuilder

Sets the specified HTTP header.

Overrides:

setHeader in class AbstractHttpFileBuilder

setHeaders

public AggregatedHttpFileBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from class: AbstractHttpFileBuilder

Sets the specified HTTP headers.

Overrides:

setHeaders in class AbstractHttpFileBuilder

contentType

public AggregatedHttpFileBuilder contentType(MediaType contentType)

Description copied from class: AbstractHttpFileBuilder

Sets the "content-type" header. This method is a shortcut for:

 builder.autoDetectedContentType(false);
 builder.setHeader(HttpHeaderNames.CONTENT_TYPE, contentType);
 

Overrides:

contentType in class AbstractHttpFileBuilder

contentType

public AggregatedHttpFileBuilder contentType(CharSequence contentType)

Description copied from class: AbstractHttpFileBuilder

Sets the "content-type" header. This method is a shortcut for:

 builder.autoDetectedContentType(false);
 builder.setHeader(HttpHeaderNames.CONTENT_TYPE, contentType);
 

Overrides:

contentType in class AbstractHttpFileBuilder

cacheControl

public AggregatedHttpFileBuilder cacheControl(CacheControl cacheControl)

Description copied from class: AbstractHttpFileBuilder

Sets the "cache-control" header. This method is a shortcut for:

 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 

Overrides:

cacheControl in class AbstractHttpFileBuilder

cacheControl

public AggregatedHttpFileBuilder cacheControl(CharSequence cacheControl)

Description copied from class: AbstractHttpFileBuilder

Sets the "cache-control" header. This method is a shortcut for:

 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 

Overrides:

cacheControl in class AbstractHttpFileBuilder