Interface SniConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

SniConfig.BuilderBase.SniConfigImpl

public interface SniConfig
extends Prototype.Api

Listener-scoped server TLS SNI policy configuration.

These options define how listener TLS virtual-host selection handles missing or unmatched ClientHello SNI hosts, and how the HTTP request authority is checked after TLS selects certificate material.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
SniAuthorityPolicy	authorityMismatch()	Policy for HTTP requests whose authority differs from the client-presented SNI host.
static SniConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static SniConfig.Builder	builder(SniConfig instance)	Create a new fluent API builder from an existing instance.
static SniConfig	create()	Create a new instance with default values.
static SniConfig	create(Config config)	Create a new instance from configuration.
SniAuthorityPolicy	fallbackAuthority()	Policy for HTTP requests that use default listener TLS but claim a configured virtual-host authority.
SniSelectionPolicy	missing()	Policy for TLS connections without an SNI host; SniSelectionPolicy.REJECT requires at least one listener virtual host.
SniSelectionPolicy	unmatched()	Policy for TLS connections with an SNI host that does not match any configured virtual host; SniSelectionPolicy.REJECT requires at least one listener virtual host.

Method Details

builder

static SniConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

missing

SniSelectionPolicy missing()

Policy for TLS connections without an SNI host; SniSelectionPolicy.REJECT requires at least one listener virtual host.

Returns:

missing SNI policy

unmatched

SniSelectionPolicy unmatched()

Policy for TLS connections with an SNI host that does not match any configured virtual host; SniSelectionPolicy.REJECT requires at least one listener virtual host.

Returns:

unmatched SNI policy

authorityMismatch

SniAuthorityPolicy authorityMismatch()

Policy for HTTP requests whose authority differs from the client-presented SNI host.

Returns:

authority mismatch policy

fallbackAuthority

SniAuthorityPolicy fallbackAuthority()

Policy for HTTP requests that use default listener TLS but claim a configured virtual-host authority.

Returns:

fallback authority policy