Class ProxyProtocolConfig.Builder

java.lang.Object

io.helidon.webserver.ProxyProtocolConfig.BuilderBase<ProxyProtocolConfig.Builder, ProxyProtocolConfig>

io.helidon.webserver.ProxyProtocolConfig.Builder

All Implemented Interfaces:

Prototype.Builder<ProxyProtocolConfig.Builder, ProxyProtocolConfig>, Builder<ProxyProtocolConfig.Builder, ProxyProtocolConfig>, ConfigBuilderSupport.ConfiguredBuilder<ProxyProtocolConfig.Builder, ProxyProtocolConfig>, Supplier<ProxyProtocolConfig>

Enclosing interface:

ProxyProtocolConfig

public static class ProxyProtocolConfig.Builder
extends ProxyProtocolConfig.BuilderBase<ProxyProtocolConfig.Builder, ProxyProtocolConfig>
implements Builder<ProxyProtocolConfig.Builder, ProxyProtocolConfig>

Fluent API builder for ProxyProtocolConfig.

Nested Class Summary

Nested classes/interfaces inherited from class ProxyProtocolConfig.BuilderBase

ProxyProtocolConfig.BuilderBase.ProxyProtocolConfigImpl

Modifier and Type	Class	Description
protected static class	ProxyProtocolConfig.BuilderBase.ProxyProtocolConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
ProxyProtocolConfig	build()	Create an instance from this builder.
ProxyProtocolConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class ProxyProtocolConfig.BuilderBase

clearTrustedProxies, config, config, enabled, enabled, from, from, preBuildPrototype, toString, trustedProxies, trustedProxies, trustedProxies, trustedProxies, trustedProxies, validatePrototype

Modifier and Type	Method	Description
ProxyProtocolConfig.Builder	clearTrustedProxies()	Clear existing value of trustedProxies.
protected Optional<Config>	config()	Configuration used to configure this instance.
ProxyProtocolConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	enabled()	Whether PROXY protocol support is enabled.
ProxyProtocolConfig.Builder	enabled(boolean enabled)	Whether PROXY protocol support is enabled.
ProxyProtocolConfig.Builder	from(ProxyProtocolConfig prototype)	Update this builder from an existing prototype instance.
ProxyProtocolConfig.Builder	from(ProxyProtocolConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
Optional<AllowList>	trustedProxies()	Trusted proxy allow list; required when PROXY protocol support is enabled.
ProxyProtocolConfig.Builder	trustedProxies(AllowList trustedProxies)	Trusted proxy allow list; required when PROXY protocol support is enabled.
ProxyProtocolConfig.Builder	trustedProxies(AllowListConfig trustedProxies)	Trusted proxy allow list; required when PROXY protocol support is enabled.
ProxyProtocolConfig.Builder	trustedProxies(Consumer<AllowListConfig.Builder> consumer)	Trusted proxy allow list; required when PROXY protocol support is enabled.
ProxyProtocolConfig.Builder	trustedProxies(Supplier<? extends AllowList> supplier)	Trusted proxy allow list; required when PROXY protocol support is enabled.
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default ProxyProtocolConfig	get()
default ProxyProtocolConfig.Builder	identity()	Instance of this builder as the correct type.
default ProxyProtocolConfig.Builder	update(Consumer<ProxyProtocolConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default ProxyProtocolConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public ProxyProtocolConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<ProxyProtocolConfig.Builder, ProxyProtocolConfig>

Returns:

an instance of the setup object created from this builder

build

public ProxyProtocolConfig build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<ProxyProtocolConfig.Builder, ProxyProtocolConfig>

Returns:

instance of the built type