Module io.helidon.webserver.context

Package io.helidon.webserver.context

Interface ContextFeatureConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<ContextFeature>

All Known Implementing Classes:

ContextFeatureConfig.BuilderBase.ContextFeatureConfigImpl

public interface ContextFeatureConfig
extends Prototype.Api

Configuration of context feature.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContextFeatureConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ContextFeatureConfig.Builder	builder(ContextFeatureConfig instance)	Create a new fluent API builder from an existing instance.
static ContextFeatureConfig	create()	Create a new instance with default values.
static ContextFeatureConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static ContextFeatureConfig	create(Config config)	Create a new instance from configuration.
String	name()	Name of this instance.
List<ContextRecordConfig>	records()	List of propagation records.
Set<String>	sockets()	List of sockets to register this feature on.
double	weight()	Weight of the context feature.

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

build

Method Details

builder

static ContextFeatureConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

weight

double weight()

Weight of the context feature. As it is used by other features, the default is quite high: 1100.0.

Returns:

weight of the feature

sockets

Set<String> sockets()

List of sockets to register this feature on. If empty, it would get registered on all sockets.

Returns:

socket names to register on, defaults to empty (all available sockets)

name

String name()

Name of this instance.

Returns:

instance name

records

List<ContextRecordConfig> records()

List of propagation records.

Returns:

records configuration