com.linecorp.armeria.server.file

Class HttpFileServiceBuilder

java.lang.Object

com.linecorp.armeria.server.file.FileServiceBuilder

com.linecorp.armeria.server.file.HttpFileServiceBuilder

Deprecated.

Use FileServiceBuilder.

@Deprecated
public class HttpFileServiceBuilder
extends FileServiceBuilder

Builds a new FileService and its FileServiceConfig. Use the factory methods in FileService if you do not override the default settings.

Method Summary

Modifier and Type	Method and Description
HttpFileServiceBuilder	addHeader(CharSequence name, Object value) Deprecated. Adds the specified HTTP header.
HttpFileServiceBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Deprecated. Adds the specified HTTP headers.
HttpFileServiceBuilder	autoIndex(boolean autoIndex) Deprecated. Sets whether FileService auto-generates a directory listing for a directory without an index.html file.
HttpFileService	build() Deprecated. Returns a newly-created HttpFileService based on the properties of this builder.
HttpFileServiceBuilder	cacheControl(CacheControl cacheControl) Deprecated. Sets the "cache-control" header.
HttpFileServiceBuilder	cacheControl(CharSequence cacheControl) Deprecated. Sets the "cache-control" header.
HttpFileServiceBuilder	clock(Clock clock) Deprecated. Sets the Clock that provides the current date and time.
HttpFileServiceBuilder	entryCacheSpec(String entryCacheSpec) Deprecated. Sets the cache spec for caching file entries.
static HttpFileServiceBuilder	forClassPath(ClassLoader classLoader, String rootDir) Deprecated. Use FileService.builder(ClassLoader, String).
static HttpFileServiceBuilder	forClassPath(String rootDir) Deprecated. Use FileService.builder(ClassLoader, String).
static HttpFileServiceBuilder	forFileSystem(Path rootDir) Deprecated. Use FileService.builder(Path).
static HttpFileServiceBuilder	forFileSystem(String rootDir) Deprecated. Use FileService.builder(Path).
static HttpFileServiceBuilder	forVfs(HttpVfs vfs) Deprecated. Use FileService.builder(HttpVfs).
HttpFileServiceBuilder	maxCacheEntries(int maxCacheEntries) Deprecated. Sets the maximum allowed number of cached file entries.
HttpFileServiceBuilder	maxCacheEntrySizeBytes(int maxCacheEntrySizeBytes) Deprecated. Sets the maximum allowed size of a cached file entry.
HttpFileServiceBuilder	serveCompressedFiles(boolean serveCompressedFiles) Deprecated. Sets whether pre-compressed files should be served.
HttpFileServiceBuilder	setHeader(CharSequence name, Object value) Deprecated. Sets the specified HTTP header.
HttpFileServiceBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers) Deprecated. Sets the specified HTTP headers.

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

toString

Methods inherited from class java.lang.Object

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

Method Detail

forFileSystem

@Deprecated
public static HttpFileServiceBuilder forFileSystem(String rootDir)

Deprecated. Use FileService.builder(Path).

Creates a new FileServiceBuilder with the specified rootDir in an O/S file system.

forFileSystem

@Deprecated
public static HttpFileServiceBuilder forFileSystem(Path rootDir)

Deprecated. Use FileService.builder(Path).

Creates a new FileServiceBuilder with the specified rootDir in an O/S file system.

forClassPath

@Deprecated
public static HttpFileServiceBuilder forClassPath(String rootDir)

Deprecated. Use FileService.builder(ClassLoader, String).

Creates a new FileServiceBuilder with the specified rootDir in the current class path.

forClassPath

@Deprecated
public static HttpFileServiceBuilder forClassPath(ClassLoader classLoader,
                                                              String rootDir)

Deprecated. Use FileService.builder(ClassLoader, String).

Creates a new FileServiceBuilder with the specified rootDir in the current class path.

forVfs

@Deprecated
public static HttpFileServiceBuilder forVfs(HttpVfs vfs)

Deprecated. Use FileService.builder(HttpVfs).

Creates a new FileServiceBuilder with the specified HttpVfs.

clock

public HttpFileServiceBuilder clock(Clock clock)

Deprecated.

Description copied from class: FileServiceBuilder

Sets the Clock that provides the current date and time.

Overrides:

clock in class FileServiceBuilder

maxCacheEntries

public HttpFileServiceBuilder maxCacheEntries(int maxCacheEntries)

Deprecated.

Description copied from class: FileServiceBuilder

Sets the maximum allowed number of cached file entries. If not set, up to 1024 entries are cached by default.

Overrides:

maxCacheEntries in class FileServiceBuilder

entryCacheSpec

public HttpFileServiceBuilder entryCacheSpec(String entryCacheSpec)

Deprecated.

Description copied from class: FileServiceBuilder

Sets the cache spec for caching file entries. If not set, "maximumSize=1024" is used by default.

Overrides:

entryCacheSpec in class FileServiceBuilder

serveCompressedFiles

public HttpFileServiceBuilder serveCompressedFiles(boolean serveCompressedFiles)

Deprecated.

Description copied from class: FileServiceBuilder

Sets whether pre-compressed files should be served. FileService supports serving files compressed with gzip, with the extension ".gz", and brotli, with the extension ".br". The extension should be appended to the original file. For example, to serve index.js either raw, gzip-compressed, or brotli-compressed, there should be three files, index.js, index.js.gz, and index.js.br. By default, this feature is disabled.

Some tools for precompressing resources during a build process include gulp-zopfli and gulp-brotli, which by default create files with the correct extension.

Overrides:

serveCompressedFiles in class FileServiceBuilder

maxCacheEntrySizeBytes

public HttpFileServiceBuilder maxCacheEntrySizeBytes(int maxCacheEntrySizeBytes)

Deprecated.

Description copied from class: FileServiceBuilder

Sets the maximum allowed size of a cached file entry. The file bigger than this value will not be cached. If not set, is used by default.

Overrides:

maxCacheEntrySizeBytes in class FileServiceBuilder

autoIndex

public HttpFileServiceBuilder autoIndex(boolean autoIndex)

Deprecated.

Description copied from class: FileServiceBuilder

Sets whether FileService auto-generates a directory listing for a directory without an index.html file. By default, this feature is disabled. Consider the security implications of when enabling this feature.

Overrides:

autoIndex in class FileServiceBuilder

addHeader

public HttpFileServiceBuilder addHeader(CharSequence name,
                                        Object value)

Deprecated.

Description copied from class: FileServiceBuilder

Adds the specified HTTP header.

Overrides:

addHeader in class FileServiceBuilder

addHeaders

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

Deprecated.

Description copied from class: FileServiceBuilder

Adds the specified HTTP headers.

Overrides:

addHeaders in class FileServiceBuilder

setHeader

public HttpFileServiceBuilder setHeader(CharSequence name,
                                        Object value)

Deprecated.

Description copied from class: FileServiceBuilder

Sets the specified HTTP header.

Overrides:

setHeader in class FileServiceBuilder

setHeaders

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

Deprecated.

Description copied from class: FileServiceBuilder

Sets the specified HTTP headers.

Overrides:

setHeaders in class FileServiceBuilder

cacheControl

public HttpFileServiceBuilder cacheControl(CacheControl cacheControl)

Deprecated.

Description copied from class: FileServiceBuilder

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

 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 

Overrides:

cacheControl in class FileServiceBuilder

cacheControl

public HttpFileServiceBuilder cacheControl(CharSequence cacheControl)

Deprecated.

Description copied from class: FileServiceBuilder

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

 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 

Overrides:

cacheControl in class FileServiceBuilder

build

public HttpFileService build()

Deprecated.

Returns a newly-created HttpFileService based on the properties of this builder.

Overrides:

build in class FileServiceBuilder