Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

Interface FileSystemHandlerConfig

All Superinterfaces:

BaseHandlerConfig, Prototype.Api

All Known Implementing Classes:

FileSystemHandlerConfig.BuilderBase.FileSystemHandlerConfigImpl

public interface FileSystemHandlerConfig
extends Prototype.Api, BaseHandlerConfig

File system based static content handler configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FileSystemHandlerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static FileSystemHandlerConfig.Builder	builder(FileSystemHandlerConfig instance)	Create a new fluent API builder from an existing instance.
static FileSystemHandlerConfig	create()	Create a new instance with default values.
static FileSystemHandlerConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static FileSystemHandlerConfig	create(Config config)	Create a new instance from configuration.
static FileSystemHandlerConfig	create(Path location)	Create a new file system based static content configuration from the defined location.
Path	location()	The directory (or a single file) that contains the root of the static content.

Methods inherited from interface io.helidon.webserver.staticcontent.BaseHandlerConfig

cachedFiles, contentTypes, context, enabled, memoryCache, pathMapper, recordCacheCapacity, sockets, welcome

Method Details

builder

static FileSystemHandlerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static FileSystemHandlerConfig.Builder builder(FileSystemHandlerConfig 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 FileSystemHandlerConfig 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

@Deprecated
static FileSystemHandlerConfig create(Config config)

Deprecated.

use create(io.helidon.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 FileSystemHandlerConfig create()

Create a new instance with default values.

Returns:

a new instance

create

static FileSystemHandlerConfig create(Path location)

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

Parameters:

location - path on file system that is the root of static content (all files under it will be available!)

Returns:

a new configuration for classpath static content handler

location

Path location()

The directory (or a single file) that contains the root of the static content.

Returns:

location to serve the static content, such as "/home/user/static-content".