ome.smuggler.config.providers

Class PriorityConfigProvider<T>

java.lang.Object

util.spring.io.FifoResource<T>

ome.smuggler.config.providers.PriorityConfigProvider<T>

All Implemented Interfaces:

util.config.ConfigProvider<T>

Direct Known Subclasses:

ArtemisPersistenceConfigProvider, CryptoConfigProvider, ImportConfigProvider, MailConfigProvider, MountPointsConfigProvider, OmeCliConfigProvider, UndertowConfigProvider

public abstract class PriorityConfigProvider<T>
extends util.spring.io.FifoResource<T>
implements util.config.ConfigProvider<T>

Base class for ConfigProvider beans that prioritize where configuration is read from. This class first attempts to read configuration items from a file named fn in the base configuration directory, where where fn is the value returned by the getConfigFileName method; if no such file is found there, then an attempt is made to read the file from the class path at /config/fn. Failing that, if fall-back configuration has been specified, then those items are returned; otherwise an empty stream is returned, meaning no configuration is available.

Constructor Summary

Constructors

Constructor and Description
PriorityConfigProvider()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getConfigFileName() Subclasses implement this method to specify the name of the configuration file to read data from.
protected org.springframework.core.io.ResourceLoader	getResourceLoader()
java.util.stream.Stream<T>	readConfig() Reads all the objects in the configuration file.
java.util.stream.Stream<T>	readConfig(util.spring.io.ResourceLocation... loci) Reads configuration from the first available out of the specified locations, falling back to hard-coded configuration if no file is available.

Methods inherited from class util.spring.io.FifoResource

getConverter, getFallback, read

Methods inherited from class java.lang.Object

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

Methods inherited from interface util.config.ConfigProvider

defaultReadConfig, first

Constructor Detail

PriorityConfigProvider

public PriorityConfigProvider()

Method Detail

getResourceLoader

protected org.springframework.core.io.ResourceLoader getResourceLoader()

Specified by:

getResourceLoader in class util.spring.io.FifoResource<T>

getConfigFileName

public abstract java.lang.String getConfigFileName()

Subclasses implement this method to specify the name of the configuration file to read data from.

Returns:

the configuration file name, e.g. 'my.config'.

readConfig

public java.util.stream.Stream<T> readConfig()
                                      throws java.lang.Exception

Reads all the objects in the configuration file.

Specified by:

readConfig in interface util.config.ConfigProvider<T>

Returns:

all configured objects; the stream may be empty but never null.

Throws:

java.lang.Exception

readConfig

public java.util.stream.Stream<T> readConfig(util.spring.io.ResourceLocation... loci)
                                      throws java.lang.Exception

Reads configuration from the first available out of the specified locations, falling back to hard-coded configuration if no file is available.

Parameters:

loci - configuration locations.

Returns:

all configured objects.

Throws:

java.lang.Exception - if an error occurs.