Module io.helidon.webserver.observe.config

Package io.helidon.webserver.observe.config

Interface ConfigObserverConfig

All Superinterfaces:

ObserverConfigBase, Prototype.Api, Prototype.Factory<ConfigObserver>

All Known Implementing Classes:

ConfigObserverConfig.BuilderBase.ConfigObserverConfigImpl

public interface ConfigObserverConfig
extends Prototype.Api, ObserverConfigBase

Interface generated from definition. Please add javadoc to the definition interface.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ConfigObserverConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ConfigObserverConfig.Builder	builder(ConfigObserverConfig instance)	Create a new fluent API builder from an existing instance.
static ConfigObserverConfig	create()	Create a new instance with default values.
static ConfigObserverConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether this observer is enabled.
String	endpoint()
String	name()
boolean	permitAll()	Permit all access, even when not authorized.
Set<String>	secrets()	Secret patterns (regular expressions) to exclude from output.

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

build

Method Details

builder

static ConfigObserverConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

endpoint

String endpoint()

name

String name()

permitAll

boolean permitAll()

Permit all access, even when not authorized.

Returns:

whether to permit access for anybody

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

Returns:

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

enabled

boolean enabled()

Whether this observer is enabled.

Returns:

false to disable observer