Class StaticContentConfig.Builder

java.lang.Object

io.helidon.webserver.staticcontent.StaticContentConfig.BuilderBase<StaticContentConfig.Builder, StaticContentConfig>

io.helidon.webserver.staticcontent.StaticContentConfig.Builder

All Implemented Interfaces:

Prototype.Builder<StaticContentConfig.Builder, StaticContentConfig>, Builder<StaticContentConfig.Builder, StaticContentFeature>, ConfigBuilderSupport.ConfiguredBuilder<StaticContentConfig.Builder, StaticContentConfig>, Supplier<StaticContentFeature>

Enclosing interface:

StaticContentConfig

public static class StaticContentConfig.Builder
extends StaticContentConfig.BuilderBase<StaticContentConfig.Builder, StaticContentConfig>
implements Builder<StaticContentConfig.Builder, StaticContentFeature>

Fluent API builder for StaticContentFeature.

Nested Class Summary

Nested classes/interfaces inherited from class StaticContentConfig.BuilderBase

StaticContentConfig.BuilderBase.StaticContentConfigImpl

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

Method Summary

Modifier and Type	Method	Description
StaticContentFeature	build()	Create an instance from this builder.
StaticContentConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class StaticContentConfig.BuilderBase

addClasspath, addClasspath, addClasspath, addContentTypes, addPath, addPath, addPath, addPreCompressedEncodings, addSocket, addSockets, classpath, classpath, clearClasspath, clearMemoryCache, clearPath, clearSockets, clearTemporaryStorage, clearWelcome, config, config, contentTypes, contentTypes, enabled, enabled, from, from, memoryCache, memoryCache, memoryCache, memoryCache, name, name, path, path, preBuildPrototype, preCompressedCrossOriginSourcingEnabled, preCompressedCrossOriginSourcingEnabled, preCompressedEnabled, preCompressedEnabled, preCompressedEncodings, preCompressedEncodings, putContentType, putPreCompressedEncoding, sockets, sockets, temporaryStorage, temporaryStorage, temporaryStorage, temporaryStorage, toString, validatePrototype, weight, weight, welcome, welcome

Modifier and Type	Method	Description
StaticContentConfig.Builder	addClasspath(ClasspathHandlerConfig classpath)	List of classpath based static content handlers.
StaticContentConfig.Builder	addClasspath(Consumer<ClasspathHandlerConfig.Builder> consumer)	List of classpath based static content handlers.
StaticContentConfig.Builder	addClasspath(List<? extends ClasspathHandlerConfig> classpath)	List of classpath based static content handlers.
StaticContentConfig.Builder	addContentTypes(Map<String, ? extends MediaType> contentTypes)	Maps a filename extension to the response content type.
StaticContentConfig.Builder	addPath(FileSystemHandlerConfig path)	List of file system based static content handlers.
StaticContentConfig.Builder	addPath(Consumer<FileSystemHandlerConfig.Builder> consumer)	List of file system based static content handlers.
StaticContentConfig.Builder	addPath(List<? extends FileSystemHandlerConfig> path)	List of file system based static content handlers.
StaticContentConfig.Builder	addPreCompressedEncodings(Map<String,String> preCompressedEncodings)	Pre-compressed content coding to file suffix mappings; defaults include br to br and gzip to gz, handler-level mappings replace these mappings rather than merging with them, an explicit empty map disables sidecar lookups by default, codings must be unique concrete valid HTTP tokens other than identity and *, and suffixes have leading dots ignored and must not contain path separators.
StaticContentConfig.Builder	addSocket(String socket)	Sockets names (listeners) that will host static content handlers, defaults to all configured sockets.
StaticContentConfig.Builder	addSockets(Set<String> sockets)	Sockets names (listeners) that will host static content handlers, defaults to all configured sockets.
List<ClasspathHandlerConfig>	classpath()	List of classpath based static content handlers.
StaticContentConfig.Builder	classpath(List<? extends ClasspathHandlerConfig> classpath)	List of classpath based static content handlers.
StaticContentConfig.Builder	clearClasspath()	Clear all classpath.
StaticContentConfig.Builder	clearMemoryCache()	Clear existing value of memoryCache.
StaticContentConfig.Builder	clearPath()	Clear all path.
StaticContentConfig.Builder	clearSockets()	Clear all sockets.
StaticContentConfig.Builder	clearTemporaryStorage()	Clear existing value of temporaryStorage.
StaticContentConfig.Builder	clearWelcome()	Clear existing value of welcome.
protected Optional<Config>	config()	Configuration used to configure this instance.
StaticContentConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Map<String, MediaType>	contentTypes()	Maps a filename extension to the response content type.
StaticContentConfig.Builder	contentTypes(Map<String, ? extends MediaType> contentTypes)	Maps a filename extension to the response content type.
boolean	enabled()	Whether this feature is enabled, defaults to true.
StaticContentConfig.Builder	enabled(boolean enabled)	Whether this feature is enabled, defaults to true.
StaticContentConfig.Builder	from(StaticContentConfig prototype)	Update this builder from an existing prototype instance.
StaticContentConfig.Builder	from(StaticContentConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<MemoryCache>	memoryCache()	Memory cache shared by the whole feature.
StaticContentConfig.Builder	memoryCache(MemoryCache memoryCache)	Memory cache shared by the whole feature.
StaticContentConfig.Builder	memoryCache(MemoryCacheConfig memoryCache)	Memory cache shared by the whole feature.
StaticContentConfig.Builder	memoryCache(Consumer<MemoryCacheConfig.Builder> consumer)	Memory cache shared by the whole feature.
String	name()	Name of this instance.
StaticContentConfig.Builder	name(String name)	Name of this instance.
List<FileSystemHandlerConfig>	path()	List of file system based static content handlers.
StaticContentConfig.Builder	path(List<? extends FileSystemHandlerConfig> path)	List of file system based static content handlers.
protected void	preBuildPrototype()	Handles providers and decorators.
boolean	preCompressedCrossOriginSourcingEnabled()	Whether classpath sidecar resources may be sourced from a different classpath origin than the logical resource by default for feature-registered handlers.
StaticContentConfig.Builder	preCompressedCrossOriginSourcingEnabled(boolean preCompressedCrossOriginSourcingEnabled)	Whether classpath sidecar resources may be sourced from a different classpath origin than the logical resource by default for feature-registered handlers.
boolean	preCompressedEnabled()	Whether pre-compressed sidecar resources should be selected by default for feature-registered directory and classpath handlers; this is disabled by default and does not apply to file system handlers configured with a single file, which require handler-level opt-in.
StaticContentConfig.Builder	preCompressedEnabled(boolean preCompressedEnabled)	Whether pre-compressed sidecar resources should be selected by default for feature-registered directory and classpath handlers; this is disabled by default and does not apply to file system handlers configured with a single file, which require handler-level opt-in.
Map<String,String>	preCompressedEncodings()	Pre-compressed content coding to file suffix mappings; defaults include br to br and gzip to gz, handler-level mappings replace these mappings rather than merging with them, an explicit empty map disables sidecar lookups by default, codings must be unique concrete valid HTTP tokens other than identity and *, and suffixes have leading dots ignored and must not contain path separators.
StaticContentConfig.Builder	preCompressedEncodings(Map<String,String> preCompressedEncodings)	Pre-compressed content coding to file suffix mappings; defaults include br to br and gzip to gz, handler-level mappings replace these mappings rather than merging with them, an explicit empty map disables sidecar lookups by default, codings must be unique concrete valid HTTP tokens other than identity and *, and suffixes have leading dots ignored and must not contain path separators.
StaticContentConfig.Builder	putContentType(String key, MediaType contentType)	Maps a filename extension to the response content type.
StaticContentConfig.Builder	putPreCompressedEncoding(String key, String preCompressedEncoding)	Pre-compressed content coding to file suffix mappings; defaults include br to br and gzip to gz, handler-level mappings replace these mappings rather than merging with them, an explicit empty map disables sidecar lookups by default, codings must be unique concrete valid HTTP tokens other than identity and *, and suffixes have leading dots ignored and must not contain path separators.
Set<String>	sockets()	Sockets names (listeners) that will host static content handlers, defaults to all configured sockets.
StaticContentConfig.Builder	sockets(Set<String> sockets)	Sockets names (listeners) that will host static content handlers, defaults to all configured sockets.
Optional<TemporaryStorage>	temporaryStorage()	Temporary storage to use across all classpath handlers.
StaticContentConfig.Builder	temporaryStorage(TemporaryStorage temporaryStorage)	Temporary storage to use across all classpath handlers.
StaticContentConfig.Builder	temporaryStorage(TemporaryStorageConfig temporaryStorage)	Temporary storage to use across all classpath handlers.
StaticContentConfig.Builder	temporaryStorage(Consumer<TemporaryStorageConfig.Builder> consumer)	Temporary storage to use across all classpath handlers.
String	toString()
protected void	validatePrototype()	Validates required properties.
double	weight()	Weight of the static content feature.
StaticContentConfig.Builder	weight(double weight)	Weight of the static content feature.
Optional<String>	welcome()	Welcome-file name.
StaticContentConfig.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 Builder

get, identity, update

Modifier and Type	Method	Description
default StaticContentFeature	get()
default StaticContentConfig.Builder	identity()	Instance of this builder as the correct type.
default StaticContentConfig.Builder	update(Consumer<StaticContentConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default StaticContentConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public StaticContentConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<StaticContentConfig.Builder, StaticContentConfig>

Returns:

an instance of the setup object created from this builder

build

public StaticContentFeature build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<StaticContentConfig.Builder, StaticContentFeature>

Returns:

instance of the built type