Module io.helidon.config

Package io.helidon.config

Class FileOverrideSource

java.lang.Object

io.helidon.config.AbstractSource

io.helidon.config.FileOverrideSource

All Implemented Interfaces:

OverrideSource, PollableSource<byte[]>, Source, WatchableSource<Path>, Supplier<OverrideSource>

public final class FileOverrideSource
extends AbstractSource
implements OverrideSource, PollableSource<byte[]>, WatchableSource<Path>

OverrideSource implementation that loads override definitions from a file on a filesystem.

See Also:

FileOverrideSource.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileOverrideSource.Builder	File OverrideSource Builder.

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

OverrideSource.OverrideData

Method Summary

Modifier and Type	Method	Description
static FileOverrideSource.Builder	builder()	Create a new builder.
Optional<ChangeWatcher<Object>>	changeWatcher()	A change watcher of this source, if it implements WatchableSource and has one configured.
static FileOverrideSource	create(Config metaConfig)	Create a new file override source from meta configuration.
boolean	exists()	If the underlying data exist at this time.
boolean	isModified(byte[] stamp)	This method is invoked to check if this source has changed.
Optional<ConfigContent.OverrideContent>	load()	Load override data from the underlying source.
Optional<PollingStrategy>	pollingStrategy()	A polling strategy of this source, if it implements PollableSource and has one configured.
Path	target()	The target of this source.
Class<Path>	targetType()	Target type as supported by this source.
protected String	uid()	Returns universal id of source to be used to construct AbstractSource.description().

Methods inherited from class io.helidon.config.AbstractSource

description, optional, retryPolicy

Methods inherited from class java.lang.Object

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

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

get

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

description, optional, retryPolicy

Method Detail

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

exists

public boolean exists()

Description copied from interface: Source

If the underlying data exist at this time. This is to prevent us loading such a source if we know it does not exist.

Specified by:

exists in interface Source

Returns:

true if the source exists, false otherwise

load

public Optional<ConfigContent.OverrideContent> load()
                                             throws ConfigException

Description copied from interface: OverrideSource

Load override data from the underlying source.

Specified by:

load in interface OverrideSource

Returns:

override data if present, empty otherwise

Throws:

ConfigException - in case the loading of data failed

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

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

target

public Path target()

Description copied from interface: WatchableSource

The target of this source.

Specified by:

target in interface WatchableSource<Path>

Returns:

target this source is configured with, never null

changeWatcher

public Optional<ChangeWatcher<Object>> changeWatcher()

Description copied from class: AbstractSource

A change watcher of this source, if it implements WatchableSource and has one configured.

Specified by:

changeWatcher in interface WatchableSource<Path>

Overrides:

changeWatcher in class AbstractSource

Returns:

change watcher if any configured

targetType

public Class<Path> targetType()

Description copied from interface: WatchableSource

Target type as supported by this source.

Specified by:

targetType in interface WatchableSource<Path>

Returns:

class of the target, by default used for WatchableSource.target()

create

public static FileOverrideSource create(Config metaConfig)

Create a new file override source from meta configuration.

Parameters:

metaConfig - meta configuration containing the path and other configuration options

Returns:

a new file override source

builder

public static FileOverrideSource.Builder builder()

Create a new builder.

Returns:

builder to create new instances of file override source