Class BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl
java.lang.Object
io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl
- All Implemented Interfaces:
Prototype.Api
,BaseHandlerConfig
- Direct Known Subclasses:
ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl
,FileSystemHandlerConfig.BuilderBase.FileSystemHandlerConfigImpl
- Enclosing class:
BaseHandlerConfig.BuilderBase<BUILDER extends BaseHandlerConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends BaseHandlerConfig>
protected static class BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl
extends Object
implements BaseHandlerConfig
Generated implementation of the prototype, can be extended by descendant prototype implementations.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.helidon.webserver.staticcontent.BaseHandlerConfig
BaseHandlerConfig.Builder, BaseHandlerConfig.BuilderBase<BUILDER extends BaseHandlerConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends BaseHandlerConfig> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
BaseHandlerConfigImpl
(BaseHandlerConfig.BuilderBase<?, ?> builder) Create an instance providing a builder. -
Method Summary
Modifier and TypeMethodDescriptionA set of files that are cached in memory at startup.Maps a filename extension to the response content type.context()
Context that will serve this handler's static resources, defaults to/
.boolean
enabled()
Whether this handle is enabled, defaults totrue
.boolean
int
hashCode()
Handles will use memory cache configured onStaticContentConfig.memoryCache()
by default.Map request path to resource path.Configure capacity of cache used for resources.sockets()
Sockets names (listeners) that will host this static content handler, defaults to all configured sockets.toString()
welcome()
Welcome-file name.
-
Constructor Details
-
BaseHandlerConfigImpl
Create an instance providing a builder.- Parameters:
builder
- extending builder base of this prototype
-
-
Method Details
-
enabled
public boolean enabled()Description copied from interface:BaseHandlerConfig
Whether this handle is enabled, defaults totrue
.- Specified by:
enabled
in interfaceBaseHandlerConfig
- Returns:
- whether enabled
-
context
Description copied from interface:BaseHandlerConfig
Context that will serve this handler's static resources, defaults to/
.- Specified by:
context
in interfaceBaseHandlerConfig
- Returns:
- context under webserver
-
sockets
Description copied from interface:BaseHandlerConfig
Sockets names (listeners) that will host this static content handler, defaults to all configured sockets. Default socket name is@default
.- Specified by:
sockets
in interfaceBaseHandlerConfig
- Returns:
- sockets to register this handler on
-
welcome
Description copied from interface:BaseHandlerConfig
Welcome-file name. In case a directory is requested, this file would be served if present. There is no welcome file by default.- Specified by:
welcome
in interfaceBaseHandlerConfig
- Returns:
- welcome-file name, such as
index.html
-
cachedFiles
Description copied from interface:BaseHandlerConfig
A set of files that are cached in memory at startup. These files are never removed from the in-memory cache, though their overall size is added to the memory cache used bytes. When using classpath, the set must contain explicit list of all files that should be cached, when using file system, it can contain a directory, and all files under that directory (recursive) would be cached as well.Note that files cached through this method may use more than the max-bytes configured for the in-memory cache (i.e. this option wins over the maximal size in bytes), so kindly be careful with what is pushed to the cache.
Files cached in memory will never be re-loaded, even if changed, until server restart!
- Specified by:
cachedFiles
in interfaceBaseHandlerConfig
- Returns:
- set of file names (or directory names if not using classpath) to cache in memory on startup
-
memoryCache
Description copied from interface:BaseHandlerConfig
Handles will use memory cache configured onStaticContentConfig.memoryCache()
by default. In case a memory cache is configured here, it will replace the memory cache used by the static content feature, and this handle will use a dedicated memory cache instead.To disable memory caching for a single handler, create the configuration, and set
enabled: false
.- Specified by:
memoryCache
in interfaceBaseHandlerConfig
- Returns:
- memory cache to use with this handler
-
contentTypes
Description copied from interface:BaseHandlerConfig
Maps a filename extension to the response content type. To have a system-wide configuration, you can use the service loader SPIMediaTypeDetector
.This method can override
MediaTypes
detection for a specific static content handler.Handler will use a union of configuration on the
StaticContentConfig
and here when used from configuration.- Specified by:
contentTypes
in interfaceBaseHandlerConfig
- Returns:
- map of file extensions to associated media type
-
pathMapper
Description copied from interface:BaseHandlerConfig
Map request path to resource path. Default uses the same path as requested. This can be used to resolve all paths to a single file, or to filter out files.- Specified by:
pathMapper
in interfaceBaseHandlerConfig
- Returns:
- function to map request path to resource path
-
recordCacheCapacity
Description copied from interface:BaseHandlerConfig
Configure capacity of cache used for resources. This cache will make sure the media type and location is discovered faster.To cache content (bytes) in memory, use
BaseHandlerConfig.memoryCache()
- Specified by:
recordCacheCapacity
in interfaceBaseHandlerConfig
- Returns:
- maximal number of cached records, only caches media type and Path, not the content
-
toString
-
equals
-
hashCode
public int hashCode()
-