Module io.helidon.config.git
Package io.helidon.config.git

Class GitConfigSourceBuilder

java.lang.Object
io.helidon.config.AbstractSourceBuilder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint>
io.helidon.config.AbstractConfigSourceBuilder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint>
io.helidon.config.git.GitConfigSourceBuilder
All Implemented Interfaces:
Builder<GitConfigSourceBuilder,GitConfigSource>, ParsableSource.Builder<GitConfigSourceBuilder>, PollableSource.Builder<GitConfigSourceBuilder>, Source.Builder<GitConfigSourceBuilder>, Supplier<GitConfigSource>
public final class GitConfigSourceBuilder extends AbstractConfigSourceBuilder<GitConfigSourceBuilder,GitConfigSourceBuilder.GitEndpoint> implements Builder<GitConfigSourceBuilder,GitConfigSource>, PollableSource.Builder<GitConfigSourceBuilder>, ParsableSource.Builder<GitConfigSourceBuilder>
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.

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.