Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

Interface TemporaryStorageConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<TemporaryStorage>

All Known Implementing Classes:

TemporaryStorageConfig.BuilderBase.TemporaryStorageConfigImpl

public interface TemporaryStorageConfig
extends Prototype.Api

Configuration of temporary storage for classpath based handlers.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_FILE_PREFIX	Default prefix.
static final String	DEFAULT_FILE_SUFFIX	Default suffix.

Method Summary

Modifier and Type	Method	Description
static TemporaryStorageConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static TemporaryStorageConfig.Builder	builder(TemporaryStorageConfig instance)	Create a new fluent API builder from an existing instance.
static TemporaryStorageConfig	create()	Create a new instance with default values.
static TemporaryStorageConfig	create(Config config)	Create a new instance from configuration.
boolean	deleteOnExit()	Whether temporary files should be deleted on JVM exit.
Optional<Path>	directory()	Location of the temporary storage, defaults to temporary storage configured for the JVM.
boolean	enabled()	Whether the temporary storage is enabled, defaults to true.
String	filePrefix()	Prefix of the files in temporary storage.
String	fileSuffix()	Suffix of the files in temporary storage.

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

build

Field Details

DEFAULT_FILE_PREFIX

static final String DEFAULT_FILE_PREFIX

Default prefix.

See Also:

• Constant Field Values

DEFAULT_FILE_SUFFIX

static final String DEFAULT_FILE_SUFFIX

Default suffix.

See Also:

• Constant Field Values

Method Details

builder

static TemporaryStorageConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

Whether the temporary storage is enabled, defaults to true. If disabled, nothing is stored in temporary directory (may have performance impact, as for example a file may be extracted from a zip file on each request).

Returns:

whether the temporary storage is enabled

directory

Optional<Path> directory()

Location of the temporary storage, defaults to temporary storage configured for the JVM.

Returns:

directory of temporary storage

filePrefix

String filePrefix()

Prefix of the files in temporary storage.

Returns:

file prefix

fileSuffix

String fileSuffix()

Suffix of the files in temporary storage.

Returns:

file suffix

deleteOnExit

boolean deleteOnExit()

Whether temporary files should be deleted on JVM exit. This is enabled by default, yet it may be useful for debugging purposes to keep the files in place.

Returns:

whether to delete temporary files on JVM exit