Module io.helidon.config

Package io.helidon.config

Class UrlOverrideSource

java.lang.Object

io.helidon.config.AbstractSource

io.helidon.config.UrlOverrideSource

All Implemented Interfaces:

OverrideSource, PollableSource<Instant>, Source, WatchableSource<URL>, Supplier<OverrideSource>

public class UrlOverrideSource
extends AbstractSource
implements OverrideSource, PollableSource<Instant>, WatchableSource<URL>

OverrideSource implementation that loads configuration override content from specified endpoint URL.

See Also:

• AbstractSource
• OverrideSources

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UrlOverrideSource.Builder	Url Override Source Builder.

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

OverrideSource.OverrideData

Method Summary

Modifier and Type	Method	Description
static UrlOverrideSource.Builder	builder()	Create a new fluent API builder to create URL override source.
Optional<ChangeWatcher<Object>>	changeWatcher()	A change watcher of this source, if it implements WatchableSource and has one configured.
static UrlOverrideSource	create(Config metaConfig)	Create a new URL override source from meta configuration.
boolean	isModified(Instant 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.
URL	target()	The target of this source.
Class<URL>	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, exists, optional, retryPolicy

Method Details

create

public static UrlOverrideSource create(Config metaConfig)

Create a new URL override source from meta configuration.

Parameters:

metaConfig - meta configuration containing at least the url key

Returns:

a new URL override source

builder

public static UrlOverrideSource.Builder builder()

Create a new fluent API builder to create URL override source.

Returns:

a new builder

isModified

public boolean isModified(Instant stamp)

Description copied from interface: PollableSource

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

Specified by:

isModified in interface PollableSource<Instant>

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<Instant>

Overrides:

pollingStrategy in class AbstractSource

Returns:

polling strategy if any configured

target

public URL target()

Description copied from interface: WatchableSource

The target of this source.

Specified by:

target in interface WatchableSource<URL>

Returns:

target this source is configured with, never null

targetType

public Class<URL> targetType()

Description copied from interface: WatchableSource

Target type as supported by this source.

Specified by:

targetType in interface WatchableSource<URL>

Returns:

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

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<URL>

Overrides:

changeWatcher in class AbstractSource

Returns:

change watcher if any configured

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

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