Module io.helidon.config.git

Package io.helidon.config.git

Class GitConfigSource

java.lang.Object

io.helidon.config.AbstractSource

io.helidon.config.AbstractConfigSource

io.helidon.config.git.GitConfigSource

All Implemented Interfaces:

ConfigSource, ParsableSource, PollableSource<byte[]>, Source, AutoCloseable, Supplier<ConfigSource>

public class GitConfigSource
extends AbstractConfigSource
implements ParsableSource, PollableSource<byte[]>, AutoCloseable

A config source which loads a configuration document from Git repository.

Config source is initialized by GitConfigSourceBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.config.spi.ParsableSource

ParsableSource.Builder<B extends ParsableSource.Builder<B>>

Nested classes/interfaces inherited from interface io.helidon.config.spi.PollableSource

PollableSource.Builder<T extends PollableSource.Builder<T>>

Nested classes/interfaces inherited from interface io.helidon.config.spi.Source

Source.Builder<B extends Source.Builder<B>>

Method Summary

Modifier and Type	Method	Description
static GitConfigSourceBuilder	builder()	Create a fluent API builder for GIT config source.
void	close()
static GitConfigSource	create(Config metaConfig)	Create an instance from meta configuration.
void	init(ConfigContext context)	Initialize the config source with a ConfigContext.
boolean	isModified(byte[] stamp)	This method is invoked to check if this source has changed.
Optional<ConfigParser.Content>	load()	Loads the underlying source data.
Optional<String>	mediaType()	Media type if on eis configured for parsing content of ParsableSource.
Optional<ConfigParser>	parser()	Config parser if one is configured to use for parsing content of ParsableSource.
Optional<PollingStrategy>	pollingStrategy()	A polling strategy of this source, if it implements PollableSource and has one configured.
Function<String,Optional<InputStream>>	relativeResolver()	Resolve relative resource to the current resource.
protected String	uid()	Returns universal id of source to be used to construct AbstractSource.description().

Methods inherited from class io.helidon.config.AbstractConfigSource

toString

Methods inherited from class io.helidon.config.AbstractSource

changeWatcher, description, optional, retryPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.config.spi.ConfigSource

get

Methods inherited from interface io.helidon.config.spi.Source

description, exists, optional, retryPolicy

Method Detail

init

public void init(ConfigContext context)

Description copied from interface: ConfigSource

Initialize the config source with a ConfigContext.

The method is executed during Config bootstrapping by Config.Builder.

Specified by:

init in interface ConfigSource

Parameters:

context - a config context

create

public static GitConfigSource create(Config metaConfig)

Create an instance from meta configuration.

Parameters:

metaConfig - meta configuration of this source

Returns:

config source configured from the meta configuration

builder

public static GitConfigSourceBuilder builder()

Create a fluent API builder for GIT config source.

Returns:

a new builder instance

uid

protected String uid()

Description copied from class: AbstractSource

Returns universal id of source to be used to construct AbstractSource.description().

Overrides:

uid in class AbstractSource

Returns:

universal id of source

parser

public Optional<ConfigParser> parser()

Description copied from class: AbstractConfigSource

Config parser if one is configured to use for parsing content of ParsableSource. If one is not configured on a source (default), a parser is chosen based on AbstractConfigSource.mediaType().

Specified by:

parser in interface ParsableSource

Overrides:

parser in class AbstractConfigSource

Returns:

a configured parser, or empty if one should be chosen from media type (or if this is not a parsable source)

pollingStrategy

public Optional<PollingStrategy> pollingStrategy()

Description copied from class: AbstractSource

A polling strategy of this source, if it implements PollableSource and has one configured.

Specified by:

pollingStrategy in interface PollableSource<byte[]>

Overrides:

pollingStrategy in class AbstractSource

Returns:

polling strategy if any configured

isModified

public boolean isModified(byte[] stamp)

Description copied from interface: PollableSource

This method is invoked to check if this source has changed.

Specified by:

isModified in interface PollableSource<byte[]>

Parameters:

stamp - the stamp of the last loaded content

Returns:

true if the current data of this config source differ from the loaded data, including cases when the source has disappeared

load

public Optional<ConfigParser.Content> load()
                                    throws ConfigException

Description copied from interface: ParsableSource

Loads the underlying source data. This method is only called when the source Source.exists().

The method can be invoked repeatedly, for example during retries. In case the underlying data is gone or does not exist, return an empty optional.

Specified by:

load in interface ParsableSource

Returns:

An instance of T as read from the underlying origin of the data (if it exists)

Throws:

ConfigException - in case of errors loading from the underlying origin

relativeResolver

public Function<String,Optional<InputStream>> relativeResolver()

Description copied from interface: ParsableSource

Resolve relative resource to the current resource.

Specified by:

relativeResolver in interface ParsableSource

Returns:

a function to resolve resource name into an input stream

mediaType

public Optional<String> mediaType()

Description copied from class: AbstractConfigSource

Media type if on eis configured for parsing content of ParsableSource. If there is none configured (default), a parser is chosen based on ConfigParser.Content.mediaType() - media type detected during load of data.

Specified by:

mediaType in interface ParsableSource

Overrides:

mediaType in class AbstractConfigSource

Returns:

configured media type or empty if none configured

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException