Interface ClasspathHandlerConfig

All Superinterfaces:

BaseHandlerConfig, Prototype.Api

All Known Implementing Classes:

ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl

public interface ClasspathHandlerConfig
extends Prototype.Api, BaseHandlerConfig

Classpath based static content handler configuration.

See Also:

• builder()

Nested Class Summary

Nested Classes

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.

Method Summary

Modifier and Type	Method	Description
static ClasspathHandlerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ClasspathHandlerConfig.Builder	builder(ClasspathHandlerConfig instance)	Create a new fluent API builder from an existing instance.
Optional<ClassLoader>	classLoader()	Class loader to use to lookup the static content resources from classpath.
static ClasspathHandlerConfig	create(Config config)	Create a new instance from configuration.
static ClasspathHandlerConfig	create(String location)	Create a new classpath based static content configuration from the defined location.
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 location() on classpath, and resolves all requested paths against this content root.
Optional<TemporaryStorage>	temporaryStorage()	Customization of temporary storage configuration.

Methods inherited from interface BaseHandlerConfig

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.

Method Details

builder

static ClasspathHandlerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ClasspathHandlerConfig.Builder builder(ClasspathHandlerConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ClasspathHandlerConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static ClasspathHandlerConfig create(String location)

Create a new classpath based static content configuration from the defined location. All other configuration is default.

Parameters:

location - location on classpath

Returns:

a new configuration for classpath static content handler

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.

Returns:

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

temporaryStorage

Optional<TemporaryStorage> temporaryStorage()

Customization of temporary storage configuration.

Returns:

temporary storage config

classLoader

Optional<ClassLoader> classLoader()

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

Returns:

class loader to use

preCompressedCrossOriginSourcingEnabled

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

boolean singleFile()

Classpath content usually starts from a 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