Module io.helidon.webserver.cors

Package io.helidon.webserver.cors

Interface CorsConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<CorsFeature>

All Known Implementing Classes:

CorsConfig.BuilderBase.CorsConfigImpl

public interface CorsConfig
extends Prototype.Api

Configuration of CORS feature.

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CorsConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static CorsConfig.Builder	builder(CorsConfig instance)	Create a new fluent API builder from an existing instance.
Optional<Config>	config()	Access to config that was used to create this feature.
static CorsConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	This feature can be disabled.
String	name()	Name of this instance.
Set<String>	sockets()	List of sockets to register this feature on.
double	weight()	Weight of the CORS feature.

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

build

Method Details

builder

static CorsConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static CorsConfig.Builder builder(CorsConfig 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 CorsConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

weight

double weight()

Weight of the CORS feature. As it is used by other features, the default is quite high: 850.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

enabled

boolean enabled()

This feature can be disabled.

Returns:

whether the feature is enabled

config

Optional<Config> config()

Access to config that was used to create this feature.

Returns:

configuration