Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

Class ClasspathHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

java.lang.Object

io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webserver.staticcontent.ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

ClasspathHandlerConfig.Builder

Enclosing interface:

ClasspathHandlerConfig

public abstract static class ClasspathHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>
extends BaseHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for ClasspathHandlerConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ClasspathHandlerConfig.BuilderBase.ClasspathHandlerConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase

BaseHandlerConfig.BuilderBase.BaseHandlerConfigImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
Optional<ClassLoader>	classLoader()	Class loader to use to lookup the static content resources from classpath.
BUILDER	classLoader(ClassLoader classLoader)	Class loader to use to lookup the static content resources from classpath.
BUILDER	clearClassLoader()	Clear existing value of this property.
BUILDER	clearTemporaryStorage()	Clear existing value of this property.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(ClasspathHandlerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ClasspathHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	location()	The location on classpath that contains the root of the static content.
BUILDER	location(String location)	The location on classpath that contains the root of the static content.
protected void	preBuildPrototype()	Handles providers and decorators.
boolean	singleFile()	Classpath content usually starts from a ClasspathHandlerConfig.location() on classpath, and resolves all requested paths against this content root.
BUILDER	singleFile(boolean singleFile)	Classpath content usually starts from a ClasspathHandlerConfig.location() on classpath, and resolves all requested paths against this content root.
Optional<TemporaryStorage>	temporaryStorage()	Customization of temporary storage configuration.
BUILDER	temporaryStorage(TemporaryStorage temporaryStorage)	Customization of temporary storage configuration.
BUILDER	temporaryStorage(TemporaryStorageConfig temporaryStorageConfig)	Customization of temporary storage configuration.
BUILDER	temporaryStorage(Consumer<TemporaryStorageConfig.Builder> consumer)	Customization of temporary storage configuration.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webserver.staticcontent.BaseHandlerConfig.BuilderBase

addCachedFile, addCachedFiles, addContentTypes, addSocket, addSockets, cachedFiles, cachedFiles, clearMemoryCache, clearRecordCacheCapacity, clearWelcome, contentTypes, contentTypes, context, context, enabled, enabled, from, from, memoryCache, memoryCache, memoryCache, memoryCache, pathMapper, pathMapper, putContentType, recordCacheCapacity, recordCacheCapacity, sockets, sockets, welcome, welcome

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(ClasspathHandlerConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(ClasspathHandlerConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

location

public BUILDER 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.

Parameters:

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

Returns:

updated builder instance

See Also:

• location()

clearTemporaryStorage

public BUILDER clearTemporaryStorage()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• temporaryStorage()

temporaryStorage

public BUILDER temporaryStorage(TemporaryStorage temporaryStorage)

Customization of temporary storage configuration.

Parameters:

temporaryStorage - temporary storage config

Returns:

updated builder instance

See Also:

• temporaryStorage()

temporaryStorage

public BUILDER temporaryStorage(TemporaryStorageConfig temporaryStorageConfig)

Customization of temporary storage configuration.

Parameters:

temporaryStorageConfig - temporary storage config

Returns:

updated builder instance

See Also:

• temporaryStorage()

temporaryStorage

public BUILDER temporaryStorage(Consumer<TemporaryStorageConfig.Builder> consumer)

Customization of temporary storage configuration.

Parameters:

consumer - temporary storage config

Returns:

updated builder instance

See Also:

• temporaryStorage()

clearClassLoader

public BUILDER clearClassLoader()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• classLoader()

classLoader

public BUILDER classLoader(ClassLoader classLoader)

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

Parameters:

classLoader - class loader to use

Returns:

updated builder instance

See Also:

• classLoader()

singleFile

public BUILDER singleFile(boolean singleFile)

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

Parameters:

singleFile - whether to consider location as a single file, defaults to false

Returns:

updated builder instance

See Also:

• singleFile()

location

public Optional<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:

the location

temporaryStorage

public Optional<TemporaryStorage> temporaryStorage()

Customization of temporary storage configuration.

Returns:

the temporary storage

classLoader

public Optional<ClassLoader> classLoader()

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

Returns:

the class loader

singleFile

public boolean singleFile()

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

the single file

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

config in class BaseHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class BaseHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class BaseHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class BaseHandlerConfig.BuilderBase<BUILDER extends ClasspathHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ClasspathHandlerConfig>