Class ClasspathHandlerConfig.Builder

java.lang.Object

io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>

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

io.helidon.webserver.staticcontent.ClasspathHandlerConfig.Builder

All Implemented Interfaces:

Prototype.Builder<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>, Builder<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>, ConfigBuilderSupport.ConfiguredBuilder<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>, Supplier<ClasspathHandlerConfig>

Enclosing interface:

ClasspathHandlerConfig

public static class ClasspathHandlerConfig.Builder
extends ClasspathHandlerConfig.BuilderBase<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>
implements Builder<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>

Fluent API builder for ClasspathHandlerConfig.

Nested Class Summary

Nested classes/interfaces inherited from class ClasspathHandlerConfig.BuilderBase

ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl

Modifier and Type	Class	Description
protected static class	ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl	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.

Method Summary

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

Methods inherited from class ClasspathHandlerConfig.BuilderBase

classLoader, classLoader, clearClassLoader, clearPreCompressedCrossOriginSourcingEnabled, clearTemporaryStorage, config, from, from, location, location, preBuildPrototype, preCompressedCrossOriginSourcingEnabled, preCompressedCrossOriginSourcingEnabled, singleFile, singleFile, temporaryStorage, temporaryStorage, temporaryStorage, temporaryStorage, toString, validatePrototype

Modifier and Type	Method	Description
Optional<ClassLoader>	classLoader()	Class loader to use to lookup the static content resources from classpath.
ClasspathHandlerConfig.Builder	classLoader(ClassLoader classLoader)	Class loader to use to lookup the static content resources from classpath.
ClasspathHandlerConfig.Builder	clearClassLoader()	Clear existing value of classLoader.
ClasspathHandlerConfig.Builder	clearPreCompressedCrossOriginSourcingEnabled()	Clear existing value of preCompressedCrossOriginSourcingEnabled.
ClasspathHandlerConfig.Builder	clearTemporaryStorage()	Clear existing value of temporaryStorage.
ClasspathHandlerConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
ClasspathHandlerConfig.Builder	from(ClasspathHandlerConfig prototype)	Update this builder from an existing prototype instance.
ClasspathHandlerConfig.Builder	from(ClasspathHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	location()	The location on classpath that contains the root of the static content.
ClasspathHandlerConfig.Builder	location(String location)	The location on classpath that contains the root of the static content.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<Boolean>	preCompressedCrossOriginSourcingEnabled()	Whether sidecar resources may be sourced from a different classpath origin than the logical resource; when not configured, feature-registered handlers inherit the feature-level value and direct services default to false.
ClasspathHandlerConfig.Builder	preCompressedCrossOriginSourcingEnabled(boolean preCompressedCrossOriginSourcingEnabled)	Whether sidecar resources may be sourced from a different classpath origin than the logical resource; when not configured, feature-registered handlers inherit the feature-level value and direct services default to false.
boolean	singleFile()	Classpath content usually starts from a ClasspathHandlerConfig.location() on classpath, and resolves all requested paths against this content root.
ClasspathHandlerConfig.Builder	singleFile(boolean singleFile)	Classpath content usually starts from a ClasspathHandlerConfig.location() on classpath, and resolves all requested paths against this content root.
Optional<TemporaryStorage>	temporaryStorage()	Customization of temporary storage configuration.
ClasspathHandlerConfig.Builder	temporaryStorage(TemporaryStorage temporaryStorage)	Customization of temporary storage configuration.
ClasspathHandlerConfig.Builder	temporaryStorage(TemporaryStorageConfig temporaryStorage)	Customization of temporary storage configuration.
ClasspathHandlerConfig.Builder	temporaryStorage(Consumer<TemporaryStorageConfig.Builder> consumer)	Customization of temporary storage configuration.
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
ClasspathHandlerConfig.Builder	addCachedFile(String cachedFile)	A set of files that are cached in memory at startup.
ClasspathHandlerConfig.Builder	addCachedFiles(Set<String> cachedFiles)	A set of files that are cached in memory at startup.
ClasspathHandlerConfig.Builder	addContentTypes(Map<String, ? extends MediaType> contentTypes)	Maps a filename extension to the response content type.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.Builder	addSocket(String socket)	Sockets names (listeners) that will host this static content handler, defaults to all configured sockets.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.Builder	cachedFiles(Set<String> cachedFiles)	A set of files that are cached in memory at startup.
ClasspathHandlerConfig.Builder	clearCachedFiles()	Clear all cachedFiles.
ClasspathHandlerConfig.Builder	clearMemoryCache()	Clear existing value of memoryCache.
ClasspathHandlerConfig.Builder	clearPreCompressedEnabled()	Clear existing value of preCompressedEnabled.
ClasspathHandlerConfig.Builder	clearPreCompressedEncodings()	Clear existing value of preCompressedEncodings.
ClasspathHandlerConfig.Builder	clearRecordCacheCapacity()	Clear existing value of recordCacheCapacity.
ClasspathHandlerConfig.Builder	clearSockets()	Clear all sockets.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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 /.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.Builder	enabled(boolean enabled)	Whether this handle is enabled, defaults to true.
ClasspathHandlerConfig.Builder	from(BaseHandlerConfig prototype)	Update this builder from an existing prototype instance.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.Builder	memoryCache(MemoryCache memoryCache)	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
ClasspathHandlerConfig.Builder	memoryCache(MemoryCacheConfig memoryCache)	Handles will use memory cache configured on StaticContentConfig.memoryCache() by default.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.Builder	putContentType(String key, MediaType contentType)	Maps a filename extension to the response content type.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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.
ClasspathHandlerConfig.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 ClasspathHandlerConfig	get()
default ClasspathHandlerConfig.Builder	identity()	Instance of this builder as the correct type.
default ClasspathHandlerConfig.Builder	update(Consumer<ClasspathHandlerConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public ClasspathHandlerConfig 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<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>

Returns:

an instance of the setup object created from this builder

build

public ClasspathHandlerConfig 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<ClasspathHandlerConfig.Builder, ClasspathHandlerConfig>

Returns:

instance of the built type