Interface ProxyProtocolConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ProxyProtocolConfig.BuilderBase.ProxyProtocolConfigImpl

public interface ProxyProtocolConfig
extends Prototype.Api

Configuration of PROXY protocol support.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ProxyProtocolConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ProxyProtocolConfig.Builder	builder(ProxyProtocolConfig instance)	Create a new fluent API builder from an existing instance.
static ProxyProtocolConfig	create()	Create a new instance with default values.
static ProxyProtocolConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether PROXY protocol support is enabled.
Optional<AllowList>	trustedProxies()	Trusted proxy allow list; required when PROXY protocol support is enabled.

Method Details

builder

static ProxyProtocolConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

Whether PROXY protocol support is enabled.

Returns:

whether PROXY protocol support is enabled, defaults to true

trustedProxies

Optional<AllowList> trustedProxies()

Trusted proxy allow list; required when PROXY protocol support is enabled.

When PROXY protocol support is enabled, this list must be configured explicitly. Incoming PROXY protocol headers are accepted only from trusted peers.

Returns:

trusted proxy allow list