HttpFileServiceBuilder (filter-service-metrics 1.12 1.12 API)

java.lang.Object
- com.linecorp.armeria.server.file.HttpFileServiceBuilder

```
public final class HttpFileServiceBuilder
extends Object
```
Builds a new HttpFileService and its HttpFileServiceConfig. Use the factory methods in HttpFileService if you do not override the default settings.

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - forFileSystem
```
public static HttpFileServiceBuilder forFileSystem(String rootDir)
```
    Creates a new HttpFileServiceBuilder with the specified rootDir in an O/S file system.
  - forFileSystem
```
public static HttpFileServiceBuilder forFileSystem(Path rootDir)
```
    Creates a new HttpFileServiceBuilder with the specified rootDir in an O/S file system.
  - forClassPath
```
public static HttpFileServiceBuilder forClassPath(String rootDir)
```
    Creates a new HttpFileServiceBuilder with the specified rootDir in the current class path.
  - forClassPath
```
public static HttpFileServiceBuilder forClassPath(ClassLoader classLoader,
                                                  String rootDir)
```
    Creates a new HttpFileServiceBuilder with the specified rootDir in the current class path.
  - forVfs
```
public static HttpFileServiceBuilder forVfs(HttpVfs vfs)
```
    Creates a new HttpFileServiceBuilder with the specified HttpVfs.
  - clock
```
public HttpFileServiceBuilder clock(Clock clock)
```
    Sets the Clock that provides the current date and time.
  - maxCacheEntries
```
public HttpFileServiceBuilder maxCacheEntries(int maxCacheEntries)
```
    Sets the maximum allowed number of cached file entries. If not set, up to 1024 entries are cached by default.
  - entryCacheSpec
```
public HttpFileServiceBuilder entryCacheSpec(String entryCacheSpec)
```
    Sets the cache spec for caching file entries. If not set, "maximumSize=1024" is used by default.
  - serveCompressedFiles
```
public HttpFileServiceBuilder serveCompressedFiles(boolean serveCompressedFiles)
```
    Sets whether pre-compressed files should be served. HttpFileService 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.
  - maxCacheEntrySizeBytes
```
public HttpFileServiceBuilder maxCacheEntrySizeBytes(int maxCacheEntrySizeBytes)
```
    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.
  - autoIndex
```
public HttpFileServiceBuilder autoIndex(boolean autoIndex)
```
    Sets whether HttpFileService 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.
  - addHeader
```
public HttpFileServiceBuilder addHeader(CharSequence name,
                                        Object value)
```
    Adds the specified HTTP header.
  - addHeaders
```
public HttpFileServiceBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Adds the specified HTTP headers.
  - setHeader
```
public HttpFileServiceBuilder setHeader(CharSequence name,
                                        Object value)
```
    Sets the specified HTTP header.
  - setHeaders
```
public HttpFileServiceBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Sets the specified HTTP headers.
  - cacheControl
```
public HttpFileServiceBuilder cacheControl(CacheControl cacheControl)
```
    Sets the "cache-control" header. This method is a shortcut of:
```
 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 
```
  - cacheControl
```
public HttpFileServiceBuilder cacheControl(CharSequence cacheControl)
```
    Sets the "cache-control" header. This method is a shortcut of:
```
 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 
```
  - build
```
public HttpFileService build()
```
    Returns a newly-created HttpFileService based on the properties of this builder.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HttpFileServiceBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forFileSystem

forFileSystem

forClassPath

forClassPath

forVfs

clock

maxCacheEntries

entryCacheSpec

serveCompressedFiles

maxCacheEntrySizeBytes

autoIndex

addHeader

addHeaders

setHeader

setHeaders

cacheControl

cacheControl

build

toString