Module io.helidon.webserver.observe.config

Package io.helidon.webserver.observe.config

Class ConfigObserverConfig.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webserver.observe.config.ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

ConfigObserverConfig.Builder

Enclosing interface:

ConfigObserverConfig

public abstract static class ConfigObserverConfig.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>
extends ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for ConfigObserverConfig.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class io.helidon.webserver.observe.ObserverConfigBase.BuilderBase

ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addSecret(String secret)	Secret patterns (regular expressions) to exclude from output.
BUILDER	addSecrets(Set<String> secrets)	Secret patterns (regular expressions) to exclude from output.
BUILDER	clearSecrets()	Clear all secrets.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
String	endpoint()	Endpoint this observer is available on.
BUILDER	endpoint(String endpoint)	Endpoint this observer is available on.
BUILDER	from(ConfigObserverConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ConfigObserverConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
boolean	permitAll()	Permit all access, even when not authorized.
BUILDER	permitAll(boolean permitAll)	Permit all access, even when not authorized.
protected void	preBuildPrototype()	Handles providers and decorators.
Set<String>	secrets()	Secret patterns (regular expressions) to exclude from output.
BUILDER	secrets(Set<String> secrets)	Secret patterns (regular expressions) to exclude from output.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webserver.observe.ObserverConfigBase.BuilderBase

config, enabled, enabled, from, from, name, name

Methods inherited from class java.lang.Object

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

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

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(ConfigObserverConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(ConfigObserverConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

Overrides:

config in class ObserverConfigBase.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

Overrides:

config in class ObserverConfigBase.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

endpoint

public BUILDER endpoint(String endpoint)

Endpoint this observer is available on.

Parameters:

endpoint - the observer endpoint

Returns:

updated builder instance

See Also:

• endpoint()

permitAll

public BUILDER permitAll(boolean permitAll)

Permit all access, even when not authorized.

Parameters:

permitAll - whether to permit access for anybody

Returns:

updated builder instance

See Also:

• permitAll()

clearSecrets

public BUILDER clearSecrets()

Clear all secrets.

Returns:

updated builder instance

See Also:

• secrets()

secrets

public BUILDER secrets(Set<String> secrets)

Secret patterns (regular expressions) to exclude from output. Any pattern that matches a key will cause the output to be obfuscated and not contain the value.

Patterns always added:

• .*password
• .*passphrase
• .*secret

Parameters:

secrets - set of regular expression patterns for keys, where values should be excluded from output

Returns:

updated builder instance

See Also:

• secrets()

addSecrets

public BUILDER addSecrets(Set<String> secrets)

Secret patterns (regular expressions) to exclude from output. Any pattern that matches a key will cause the output to be obfuscated and not contain the value.

Patterns always added:

• .*password
• .*passphrase
• .*secret

Parameters:

secrets - set of regular expression patterns for keys, where values should be excluded from output

Returns:

updated builder instance

See Also:

• secrets()

addSecret

public BUILDER addSecret(String secret)

Secret patterns (regular expressions) to exclude from output. Any pattern that matches a key will cause the output to be obfuscated and not contain the value.

Patterns always added:

• .*password
• .*passphrase
• .*secret

Parameters:

secret - add single set of regular expression patterns for keys, where values should be excluded from output

Returns:

updated builder instance

See Also:

• secrets()

endpoint

public String endpoint()

Endpoint this observer is available on.

Returns:

the observer endpoint

permitAll

public boolean permitAll()

Permit all access, even when not authorized.

Returns:

whether to permit access for anybody

secrets

public Set<String> secrets()

Secret patterns (regular expressions) to exclude from output. Any pattern that matches a key will cause the output to be obfuscated and not contain the value.

Patterns always added:

• .*password
• .*passphrase
• .*secret

Returns:

set of regular expression patterns for keys, where values should be excluded from output

toString

public String toString()

Overrides:

toString in class ObserverConfigBase.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ObserverConfigBase.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ObserverConfigBase.BuilderBase<BUILDER extends ConfigObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigObserverConfig>