Class FileSystemHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>

java.lang.Object

io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>

io.helidon.webserver.staticcontent.FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Direct Known Subclasses:

FileSystemHandlerConfig.Builder

Enclosing interface:

FileSystemHandlerConfig

public abstract static class FileSystemHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>
extends BaseHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Fluent API builder base for FileSystemHandlerConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FileSystemHandlerConfig.BuilderBase.FileSystemHandlerConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class BaseHandlerConfig.BuilderBase

BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

Modifier and Type	Class	Description
protected static class	BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(FileSystemHandlerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(FileSystemHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Path>	location()	The directory (or a single file) that contains the root of the static content.
BUILDER	location(Path location)	The directory (or a single file) that contains the root of the static content.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class BaseHandlerConfig.BuilderBase

addCachedFile, addCachedFiles, addContentTypes, addPreCompressedEncodings, addSocket, addSockets, cachedFiles, cachedFiles, clearCachedFiles, clearMemoryCache, clearPreCompressedEnabled, clearPreCompressedEncodings, clearRecordCacheCapacity, clearSockets, clearWelcome, config, contentTypes, contentTypes, context, context, enabled, enabled, from, from, memoryCache, memoryCache, memoryCache, memoryCache, pathMapper, pathMapper, preCompressedEnabled, preCompressedEnabled, preCompressedEncodings, preCompressedEncodings, putContentType, putPreCompressedEncoding, recordCacheCapacity, recordCacheCapacity, sockets, sockets, welcome, welcome

Modifier and Type	Method	Description
BUILDER	addCachedFile(String cachedFile)	A set of files that are cached in memory at startup.
BUILDER	addCachedFiles(Set<String> cachedFiles)	A set of files that are cached in memory at startup.
BUILDER	addContentTypes(Map<String, ? extends MediaType> contentTypes)	Maps a filename extension to the response content type.
BUILDER	addPreCompressedEncodings(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.
BUILDER	addSocket(String socket)	Sockets names (listeners) that will host this static content handler, defaults to all configured sockets.
BUILDER	addSockets(Set<String> sockets)	Sockets names (listeners) that will host this static content handler, defaults to all configured sockets.
Set<String>	cachedFiles()	A set of files that are cached in memory at startup.
BUILDER	cachedFiles(Set<String> cachedFiles)	A set of files that are cached in memory at startup.
BUILDER	clearCachedFiles()	Clear all cachedFiles.
BUILDER	clearMemoryCache()	Clear existing value of memoryCache.
BUILDER	clearPreCompressedEnabled()	Clear existing value of preCompressedEnabled.
BUILDER	clearPreCompressedEncodings()	Clear existing value of preCompressedEncodings.
BUILDER	clearRecordCacheCapacity()	Clear existing value of recordCacheCapacity.
BUILDER	clearSockets()	Clear all sockets.
BUILDER	clearWelcome()	Clear existing value of welcome.
protected Optional<Config>	config()	Configuration used to configure this instance.
Map<String, MediaType>	contentTypes()	Maps a filename extension to the response content type.
BUILDER	contentTypes(Map<String, ? extends MediaType> contentTypes)	Maps a filename extension to the response content type.
String	context()	Context that will serve this handler's static resources, defaults to /.
BUILDER	context(String context)	Context that will serve this handler's static resources, defaults to /.
boolean	enabled()	Whether this handle is enabled, defaults to true.
BUILDER	enabled(boolean enabled)	Whether this handle is enabled, defaults to true.
BUILDER	from(BaseHandlerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(BaseHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<MemoryCache>	memoryCache()	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
BUILDER	memoryCache(MemoryCache memoryCache)	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
BUILDER	memoryCache(MemoryCacheConfig memoryCache)	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
BUILDER	memoryCache(Consumer<MemoryCacheConfig.Builder> consumer)	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
Function<String,String>	pathMapper()	Map request path to resource path.
BUILDER	pathMapper(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.
BUILDER	preCompressedEnabled(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.
BUILDER	preCompressedEncodings(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.
BUILDER	putContentType(String key, MediaType contentType)	Maps a filename extension to the response content type.
BUILDER	putPreCompressedEncoding(String key, String preCompressedEncoding)	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.
BUILDER	recordCacheCapacity(int 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.
BUILDER	sockets(Set<String> sockets)	Sockets names (listeners) that will host this static content handler, defaults to all configured sockets.
Optional<String>	welcome()	Welcome-file name.
BUILDER	welcome(String welcome)	Welcome-file name.

Methods inherited from class Object

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

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(FileSystemHandlerConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(FileSystemHandlerConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

location

public BUILDER location(Path location)

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

Parameters:

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

Returns:

updated builder instance

See Also:

• location()

location

public Optional<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".

toString

public String toString()

Overrides:

toString in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class BaseHandlerConfig.BuilderBase<BUILDER extends FileSystemHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FileSystemHandlerConfig>