Package io.helidon.config.git

Class GitConfigSourceBuilder

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<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint>

io.helidon.config.git.GitConfigSourceBuilder

All Implemented Interfaces:

Builder<ConfigSource>, Supplier<ConfigSource>

public final class GitConfigSourceBuilder
extends AbstractParsableConfigSource.Builder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint>

Git ConfigSource builder.

Creates a GitConfigSource while allowing the application to the following properties:

• path - a relative path to the configuration file in repository
• uri - an uri to the repository
• directory - a directory with a cloned repository - by default it is a temporary dir created by calling Files.createTempFile(String, String, FileAttribute[]) with the prefix helidon-config-git-source-
• branch - a git branch - a default value is master
• optional - 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;

The application should invoke the builder's build method in a try-release block -- or otherwise make sure that it invokes the GitConfigSource#close method -- to clean up the config source when the application no longer needs it.

If the directory is not set, a temporary directory is created (see Files.createTempDirectory(String, FileAttribute[]). The temporary file is cleaned up by the GitConfigSource.close() method). A specified directory, that is not empty, must be a valid git repository, otherwise an exception is thrown. If the directory nor the uri is not set, an exception is thrown.

If Git 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	GitConfigSourceBuilder.GitEndpoint	Git source endpoint descriptor.

Method Summary

Modifier and Type	Method	Description
GitConfigSourceBuilder	branch(String branch)	Sets a git branch to checkout.
GitConfigSource	build()	Builds new instance of S.
static GitConfigSourceBuilder	create(Config metaConfig)	Initializes config source instance from meta configuration properties, see ConfigSources.load(Config).
static GitConfigSourceBuilder	create(String path)	Creates a builder with mandatory path to the configuration source.
GitConfigSourceBuilder	credentials(String user, String password)	Sets user and password to the repository.
GitConfigSourceBuilder	credentialsProvider(org.eclipse.jgit.transport.CredentialsProvider credentialsProvider)	Sets new CredentialsProvider which should be used by application.
GitConfigSourceBuilder	directory(Path directory)	Sets a directory where the repository is cloned or should be cloned.
protected GitConfigSourceBuilder	init(Config metaConfig)	Initialize builder from specified configuration properties.
protected GitConfigSourceBuilder.GitEndpoint	target()	Returns key source attributes (target).
GitConfigSourceBuilder	uri(URI uri)	Sets an uri to the repository.

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 GitConfigSourceBuilder create(String path)

Creates a builder with mandatory path to the configuration source.

Parameters:

path - a path to the configuration file

Returns:

a new builder

See Also:

create(Config)

create

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

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

Mandatory properties, see create(String):

• path - type String

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(String), init(Config)

init

protected GitConfigSourceBuilder init(Config metaConfig)

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)

• uri - type URI, see uri(URI)
• branch - type String, see branch(String)
• directory - type Path, see directory(Path)

Overrides:

init in class AbstractParsableConfigSource.Builder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint>

Parameters:

metaConfig - configuration properties used to initialize a builder instance.

Returns:

modified builder instance

target

protected GitConfigSourceBuilder.GitEndpoint target()

Description copied from class: AbstractSource.Builder

Returns key source attributes (target).

Overrides:

target in class AbstractSource.Builder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint,ConfigSource>

Returns:

key source attributes (target).

branch

public GitConfigSourceBuilder branch(String branch)

Sets a git branch to checkout.

Parameters:

branch - a git branch

Returns:

this builder

directory

public GitConfigSourceBuilder directory(Path directory)

Sets a directory where the repository is cloned or should be cloned.

Parameters:

directory - a local git repository

Returns:

this builder

uri

public GitConfigSourceBuilder uri(URI uri)

Sets an uri to the repository.

Parameters:

uri - an uri to the repository

Returns:

this builder

credentials

public GitConfigSourceBuilder credentials(String user,
                                          String password)

Sets user and password to the repository.

Parameters:

user - user to the repository

password - password to the repository

Returns:

this builder

credentialsProvider

public GitConfigSourceBuilder credentialsProvider(org.eclipse.jgit.transport.CredentialsProvider credentialsProvider)

Sets new CredentialsProvider which should be used by application.

Parameters:

credentialsProvider - credentials provider

Returns:

this builder

build

public GitConfigSource build()

Description copied from class: AbstractSource.Builder

Builds new instance of S.

Specified by:

build in interface Builder<ConfigSource>

Specified by:

build in class AbstractSource.Builder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint,ConfigSource>

Returns:

new instance of S.