Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

Interface StaticContentConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<StaticContentFeature>

All Known Implementing Classes:

StaticContentConfig.BuilderBase.StaticContentConfigImpl

public interface StaticContentConfig
extends Prototype.Api

Configuration of Static content feature.

Minimal example configuring a single classpath resource (properties):

 server.features.static-content.classpath.0.context=/static
 server.features.static-content.classpath.0.location=/web
 

and using yaml:

 server:
   features:
     static-content:
       classpath:
         - context: "/static"
           location: "/web"
 

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StaticContentConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static StaticContentConfig.Builder	builder(StaticContentConfig instance)	Create a new fluent API builder from an existing instance.
List<ClasspathHandlerConfig>	classpath()	List of classpath based static content handlers.
Map<String,MediaType>	contentTypes()	Maps a filename extension to the response content type.
static StaticContentConfig	create()	Create a new instance with default values.
static StaticContentConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static StaticContentConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether this feature is enabled, defaults to true.
Optional<MemoryCache>	memoryCache()	Memory cache shared by the whole feature.
String	name()	Name of this instance.
List<FileSystemHandlerConfig>	path()	List of file system based static content handlers.
Set<String>	sockets()	Sockets names (listeners) that will host static content handlers, defaults to all configured sockets.
Optional<TemporaryStorage>	temporaryStorage()	Temporary storage to use across all classpath handlers.
double	weight()	Weight of the static content feature.
Optional<String>	welcome()	Welcome-file name.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Method Details

builder

static StaticContentConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static StaticContentConfig.Builder builder(StaticContentConfig 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 StaticContentConfig 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 StaticContentConfig 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 StaticContentConfig create()

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

Whether this feature is enabled, defaults to true.

Returns:

whether this feature is enabled

weight

double weight()

Weight of the static content feature. Defaults to 95.0.

Returns:

weight of the feature

name

String name()

Name of this instance.

Returns:

instance name

memoryCache

Optional<MemoryCache> memoryCache()

Memory cache shared by the whole feature. If not configured, files are not cached in memory (except for explicitly marked files/resources in each section).

Returns:

memory cache, if configured

temporaryStorage

Optional<TemporaryStorage> temporaryStorage()

Temporary storage to use across all classpath handlers. If not defined, a default one will be created.

Returns:

temporary storage

classpath

List<ClasspathHandlerConfig> classpath()

List of classpath based static content handlers.

Returns:

classpath handlers

path

List<FileSystemHandlerConfig> path()

List of file system based static content handlers.

Returns:

path handlers

contentTypes

Map<String,MediaType> contentTypes()

Maps a filename extension to the response content type. To have a system-wide configuration, you can use the service loader SPI MediaTypeDetector.

This method can override MediaTypes detection for a specific static content handler.

Handler will use a union of configuration defined here, and on the handler here when used from configuration.

Returns:

map of file extensions to associated media type

welcome

Optional<String> welcome()

Welcome-file name. Default for all handlers. By default, we do not serve default files.

Returns:

welcome-file name, such as index.html

sockets

Set<String> sockets()

Sockets names (listeners) that will host static content handlers, defaults to all configured sockets. Default socket name is @default.

This configures defaults for all handlers.

Returns:

sockets to register this handler on