Interface FileSystemHandlerConfig

All Superinterfaces:

BaseHandlerConfig, Prototype.Api

All Known Implementing Classes:

FileSystemHandlerConfig.BuilderBase.FileSystemHandlerConfigImpl

public interface FileSystemHandlerConfig
extends Prototype.Api, BaseHandlerConfig

File system based static content handler configuration.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FileSystemHandlerConfig.Builder	Fluent API builder for FileSystemHandlerConfig.
static class	FileSystemHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>	Fluent API builder base for FileSystemHandlerConfig.

Method Summary

Modifier and Type	Method	Description
static FileSystemHandlerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static FileSystemHandlerConfig.Builder	builder(FileSystemHandlerConfig instance)	Create a new fluent API builder from an existing instance.
static FileSystemHandlerConfig	create(Config config)	Create a new instance from configuration.
static FileSystemHandlerConfig	create(Path location)	Create a new file system based static content configuration from the defined location.
Path	location()	The directory (or a single file) that contains the root of the static content.

Methods inherited from interface BaseHandlerConfig

cachedFiles, contentTypes, context, enabled, memoryCache, pathMapper, preCompressedEnabled, preCompressedEncodings, recordCacheCapacity, sockets, welcome

Modifier and Type	Method	Description
Set<String>	cachedFiles()	A set of files that are cached in memory at startup.
Map<String, MediaType>	contentTypes()	Maps a filename extension to the response content type.
String	context()	Context that will serve this handler's static resources, defaults to /.
boolean	enabled()	Whether this handle is enabled, defaults to true.
Optional<MemoryCache>	memoryCache()	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
Function<String,String>	pathMapper()	Map request path to resource path.
Optional<Boolean>	preCompressedEnabled()	Whether pre-compressed sidecar resources should be selected for this handler; feature-registered handlers inherit the feature value when absent, directly created handlers default to disabled, and file system handlers configured with a single file always require handler-level opt-in.
Optional<Map<String,String>>	preCompressedEncodings()	Pre-compressed content coding to file suffix mappings; handler mappings replace inherited feature-level mappings rather than merging with them, an explicit empty map disables sidecar lookups for this handler, codings must be unique concrete valid HTTP tokens other than identity and *, and suffixes have leading dots ignored and must not contain path separators.
Optional<Integer>	recordCacheCapacity()	Configures the capacity of the cache used for resource metadata.
Set<String>	sockets()	Sockets names (listeners) that will host this static content handler, defaults to all configured sockets.
Optional<String>	welcome()	Welcome-file name.

Method Details

builder

static FileSystemHandlerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static FileSystemHandlerConfig.Builder builder(FileSystemHandlerConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static FileSystemHandlerConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static FileSystemHandlerConfig create(Path location)

Create a new file system based static content configuration from the defined location. All other configuration is default.

Parameters:

location - path on file system that is the root of static content (all files under it will be available!)

Returns:

a new configuration for classpath static content handler

location

Path location()

The directory (or a single file) that contains the root of the static content.

Returns:

location to serve the static content, such as "/home/user/static-content".