Module io.helidon.webserver.security

Package io.helidon.webserver.security

Interface SecurityFeatureConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<SecurityFeature>

All Known Implementing Classes:

SecurityFeatureConfig.BuilderBase.SecurityFeatureConfigImpl

public interface SecurityFeatureConfig
extends Prototype.Api

Configuration of security feature fow webserver.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SecurityFeatureConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static SecurityFeatureConfig.Builder	builder(SecurityFeatureConfig instance)	Create a new fluent API builder from an existing instance.
static SecurityFeatureConfig	create()	Create a new instance with default values.
static SecurityFeatureConfig	create(Config config)	Create a new instance from configuration.
SecurityHandler	defaults()	The default security handler.
String	name()	Name of this instance.
List<PathsConfig>	paths()	Configuration for webserver paths.
Security	security()	Security associated with this feature.
double	weight()	Weight of the security feature.

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

build

Method Details

builder

static SecurityFeatureConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

weight

double weight()

Weight of the security feature. Value is: 800.0.

Returns:

weight of the feature

defaults

SecurityHandler defaults()

The default security handler.

Returns:

security handler defaults

paths

List<PathsConfig> paths()

Configuration for webserver paths.

Returns:

path configuration

security

Security security()

Security associated with this feature. If not specified here, the feature uses security registered with Contexts.globalContext(), if not found, it creates a new instance from root of configuration (using security key).

This configuration allows usage of a different security instance for a specific security feature setup.

Returns:

security instance to be used to handle security in this feature configuration

name

String name()

Name of this instance.

Returns:

instance name