Class ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl

java.lang.Object

io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

io.helidon.webserver.staticcontent.ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl

All Implemented Interfaces:

Prototype.Api, BaseHandlerConfig, ClasspathHandlerConfig

Enclosing class:

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

protected static class ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl
extends BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl
implements ClasspathHandlerConfig

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface BaseHandlerConfig

BaseHandlerConfig.Builder, BaseHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>

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

Nested classes/interfaces inherited from interface ClasspathHandlerConfig

ClasspathHandlerConfig.Builder, ClasspathHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClasspathHandlerConfigImpl(ClasspathHandlerConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Optional<ClassLoader>	classLoader()	Class loader to use to lookup the static content resources from classpath.
boolean	equals(Object o)
int	hashCode()
String	location()	The location on classpath that contains the root of the static content.
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.
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.
String	toString()

Methods inherited from class BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

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.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ClasspathHandlerConfigImpl

protected ClasspathHandlerConfigImpl(ClasspathHandlerConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

location

public String location()

Description copied from interface: ClasspathHandlerConfig

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.

Specified by:

location in interface ClasspathHandlerConfig

Returns:

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

temporaryStorage

public Optional<TemporaryStorage> temporaryStorage()

Description copied from interface: ClasspathHandlerConfig

Customization of temporary storage configuration.

Specified by:

temporaryStorage in interface ClasspathHandlerConfig

Returns:

temporary storage config

classLoader

public Optional<ClassLoader> classLoader()

Description copied from interface: ClasspathHandlerConfig

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

Specified by:

classLoader in interface ClasspathHandlerConfig

Returns:

class loader to use

preCompressedCrossOriginSourcingEnabled

public Optional<Boolean> preCompressedCrossOriginSourcingEnabled()

Description copied from interface: ClasspathHandlerConfig

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.

Specified by:

preCompressedCrossOriginSourcingEnabled in interface ClasspathHandlerConfig

Returns:

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

singleFile

public boolean singleFile()

Description copied from interface: ClasspathHandlerConfig

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.

Specified by:

singleFile in interface ClasspathHandlerConfig

Returns:

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

toString

public String toString()

Overrides:

toString in class BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl