Package io.helidon.config.etcd

Class EtcdConfigSourceBuilder

java.lang.Object

io.helidon.config.spi.AbstractSource.Builder<B,T,ConfigSource>

io.helidon.config.spi.AbstractConfigSource.Builder<B,T>

io.helidon.config.spi.AbstractParsableConfigSource.Builder<EtcdConfigSourceBuilder,EtcdConfigSourceBuilder.EtcdEndpoint>

io.helidon.config.etcd.EtcdConfigSourceBuilder

All Implemented Interfaces:

Builder<ConfigSource>, Supplier<ConfigSource>

public final class EtcdConfigSourceBuilder
extends AbstractParsableConfigSource.Builder<EtcdConfigSourceBuilder,EtcdConfigSourceBuilder.EtcdEndpoint>

Etcd ConfigSource builder.

It allows to configure following properties:

• uri - etcd endpoint
• key - an etcd key that is associated to value with configuration
• version - an etcd API version
• mandatory - is existence of configuration resource mandatory (by default) or is optional?
• media-type - configuration content media type to be used to look for appropriate ConfigParser;
• parser - or directly set ConfigParser instance to be used to parse the source;

If the Etcd ConfigSource is mandatory and a uri is not responsive or key does not exist then Source.load() throws ConfigException.

One of media-type and parser properties must be set to be clear how to parse the content. If both of them are set, then parser has precedence.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EtcdConfigSourceBuilder.EtcdApi	EtcdApi determines which etcd API version will be used.
static class	EtcdConfigSourceBuilder.EtcdEndpoint	Etcd endpoint remote descriptor.

Method Summary

Modifier and Type	Method	Description
EtcdConfigSource	build()	Builds new instance of Etcd ConfigSource.
static EtcdConfigSourceBuilder	create(Config metaConfig)	Initializes config source instance from meta configuration properties, see ConfigSources.load(Config).
static EtcdConfigSourceBuilder	create(URI uri, String key, EtcdConfigSourceBuilder.EtcdApi api)	Create new instance of builder with specified mandatory Etcd endpoint remote descriptor.
protected EtcdConfigSourceBuilder	init(Config metaConfig)	Initialize builder from specified configuration properties.
protected EtcdConfigSourceBuilder.EtcdEndpoint	target()	Returns key source attributes (target).

Methods inherited from class io.helidon.config.spi.AbstractParsableConfigSource.Builder

mediaType, mediaType, parser, parser

Methods inherited from class io.helidon.config.spi.AbstractConfigSource.Builder

get, mediaTypeMapping, mediaTypeMapping, parserMapping, parserMapping

Methods inherited from class io.helidon.config.spi.AbstractSource.Builder

changesExecutor, changesExecutor, changesMaxBuffer, changesMaxBuffer, isMandatory, optional, pollingStrategy, pollingStrategy, pollingStrategy, retryPolicy, retryPolicy, thisBuilder

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EtcdConfigSourceBuilder create(URI uri,
                                             String key,
                                             EtcdConfigSourceBuilder.EtcdApi api)

Create new instance of builder with specified mandatory Etcd endpoint remote descriptor.

Parameters:

uri - an Etcd endpoint remote URI.

key - an Etcd key with which the value containing the configuration is associated.

api - an Etcd API version.

Returns:

new instance of builder

See Also:

create(Config)

create

public static EtcdConfigSourceBuilder create(Config metaConfig)
                                      throws ConfigMappingException,
                                             MissingValueException

Initializes config source instance from meta configuration properties, see ConfigSources.load(Config).

Mandatory properties, see create(URI, String, EtcdApi):

• uri - type URI
• key - type String
• api - type EtcdConfigSourceBuilder.EtcdApi, e.g. v3

Optional properties: see init(Config).

Parameters:

metaConfig - meta-configuration used to initialize returned config source builder instance from.

Returns:

new instance of config source builder described by metaConfig

Throws:

MissingValueException - in case the configuration tree does not contain all expected sub-nodes required by the mapper implementation to provide instance of Java type.

ConfigMappingException - in case the mapper fails to map the (existing) configuration tree represented by the supplied configuration node to an instance of a given Java type.

See Also:

create(URI, String, EtcdApi), init(Config)

init

protected EtcdConfigSourceBuilder init(Config metaConfig)

Description copied from class: AbstractParsableConfigSource.Builder

Initialize builder from specified configuration properties.

Supported configuration properties:

• optional - type boolean, see AbstractSource.Builder.optional()
• polling-strategy - see PollingStrategy for details about configuration format, see AbstractSource.Builder.pollingStrategy(Supplier) or AbstractSource.Builder.pollingStrategy(Function)

• media-type-mapping - type Map - key to media type, see AbstractConfigSource.Builder.mediaTypeMapping(Function)

• media-type - type String, see AbstractParsableConfigSource.Builder.mediaType(String)

Overrides:

init in class AbstractParsableConfigSource.Builder<EtcdConfigSourceBuilder,EtcdConfigSourceBuilder.EtcdEndpoint>

Parameters:

metaConfig - configuration properties used to initialize a builder instance.

Returns:

modified builder instance

target

protected EtcdConfigSourceBuilder.EtcdEndpoint target()

Description copied from class: AbstractSource.Builder

Returns key source attributes (target).

Overrides:

target in class AbstractSource.Builder<EtcdConfigSourceBuilder,EtcdConfigSourceBuilder.EtcdEndpoint,ConfigSource>

Returns:

key source attributes (target).

build

public EtcdConfigSource build()

Builds new instance of Etcd ConfigSource.

If the Etcd ConfigSource is mandatory and a uri is not responsive or key does not exist then Source.load() throws ConfigException.

Specified by:

build in interface Builder<ConfigSource>

Specified by:

build in class AbstractSource.Builder<EtcdConfigSourceBuilder,EtcdConfigSourceBuilder.EtcdEndpoint,ConfigSource>

Returns:

new instance of Etcd ConfigSource.