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

java.lang.Object

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

io.helidon.webserver.staticcontent.ClasspathHandlerConfig.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:

ClasspathHandlerConfig.Builder

Enclosing interface:

ClasspathHandlerConfig

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

Fluent API builder base for ClasspathHandlerConfig.

Nested Class Summary

Nested Classes

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<ClassLoader>	classLoader()	Class loader to use to lookup the static content resources from classpath.
BUILDER	classLoader(ClassLoader classLoader)	Class loader to use to lookup the static content resources from classpath.
BUILDER	clearClassLoader()	Clear existing value of classLoader.
BUILDER	clearPreCompressedCrossOriginSourcingEnabled()	Clear existing value of preCompressedCrossOriginSourcingEnabled.
BUILDER	clearTemporaryStorage()	Clear existing value of temporaryStorage.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(ClasspathHandlerConfig prototype)	Update this builder from an existing prototype instance.
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.
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.
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.
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.
BUILDER	temporaryStorage(TemporaryStorage temporaryStorage)	Customization of temporary storage configuration.
BUILDER	temporaryStorage(TemporaryStorageConfig temporaryStorage)	Customization of temporary storage configuration.
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
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(ClasspathHandlerConfig 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(ClasspathHandlerConfig.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 ClasspathHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ClasspathHandlerConfig>

Overrides:

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

Parameters:

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

Returns:

updated builder instance

location

public BUILDER location(String location)

The location on classpath that contains the root of the static content. This should never be the root (i.e. /), as that would allow serving of all class files.

Parameters:

location - location on classpath to serve the static content, such as "/web".

Returns:

updated builder instance

See Also:

• location()

clearTemporaryStorage

public BUILDER clearTemporaryStorage()

Clear existing value of temporaryStorage.

Returns:

updated builder instance

See Also:

• temporaryStorage()

temporaryStorage

public BUILDER temporaryStorage(TemporaryStorage temporaryStorage)

Customization of temporary storage configuration.

Parameters:

temporaryStorage - temporary storage config

Returns:

updated builder instance

See Also:

• temporaryStorage()

temporaryStorage

public BUILDER temporaryStorage(TemporaryStorageConfig temporaryStorage)

Customization of temporary storage configuration.

Parameters:

temporaryStorage - prototype of temporary storage config

Returns:

updated builder instance

See Also:

• temporaryStorage()

temporaryStorage

public BUILDER temporaryStorage(Consumer<TemporaryStorageConfig.Builder> consumer)

Customization of temporary storage configuration.

Parameters:

consumer - consumer of builder of temporary storage config

Returns:

updated builder instance

See Also:

• temporaryStorage()

clearClassLoader

public BUILDER clearClassLoader()

Clear existing value of classLoader.

Returns:

updated builder instance

See Also:

• classLoader()

classLoader

public BUILDER classLoader(ClassLoader classLoader)

Class loader to use to lookup the static content resources from classpath.

Parameters:

classLoader - class loader to use

Returns:

updated builder instance

See Also:

• classLoader()

clearPreCompressedCrossOriginSourcingEnabled

public BUILDER clearPreCompressedCrossOriginSourcingEnabled()

Clear existing value of preCompressedCrossOriginSourcingEnabled.

Returns:

updated builder instance

See Also:

• preCompressedCrossOriginSourcingEnabled()

preCompressedCrossOriginSourcingEnabled

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

Parameters:

preCompressedCrossOriginSourcingEnabled - whether cross-origin classpath sidecar sourcing is explicitly enabled or disabled

Returns:

updated builder instance

See Also:

• preCompressedCrossOriginSourcingEnabled()

singleFile

public BUILDER singleFile(boolean singleFile)

Classpath content usually starts from a ClasspathHandlerConfig.location() on classpath, and resolves all requested paths against this content root. When this property is set to true we consider the location to be a file, that is returned for any requested path under the configured BaseHandlerConfigBlueprint.context().

Note that when this is used, there will never be a redirect returned.

Parameters:

singleFile - whether to consider location as a single file, defaults to false

Returns:

updated builder instance

See Also:

• singleFile()

location

public Optional<String> location()

The location on classpath that contains the root of the static content. This should never be the root (i.e. /), as that would allow serving of all class files.

Returns:

location on classpath to serve the static content, such as "/web".

temporaryStorage

public Optional<TemporaryStorage> temporaryStorage()

Customization of temporary storage configuration.

Returns:

temporary storage config

classLoader

public Optional<ClassLoader> classLoader()

Class loader to use to lookup the static content resources from classpath.

Returns:

class loader to use

preCompressedCrossOriginSourcingEnabled

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

Returns:

whether cross-origin classpath sidecar sourcing is explicitly enabled or disabled

singleFile

public boolean singleFile()

Classpath content usually starts from a ClasspathHandlerConfig.location() on classpath, and resolves all requested paths against this content root. When this property is set to true we consider the location to be a file, that is returned for any requested path under the configured BaseHandlerConfigBlueprint.context().

Note that when this is used, there will never be a redirect returned.

Returns:

whether to consider location as a single file, defaults to false

toString

public String toString()

Overrides:

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

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

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

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

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