Module io.inverno.mod.configuration

Package io.inverno.mod.configuration.source

Class CompositeConfigurationSource

java.lang.Object

io.inverno.mod.configuration.source.CompositeConfigurationSource

All Implemented Interfaces:

ConfigurationSource

Direct Known Subclasses:

BootstrapConfigurationSource

public class CompositeConfigurationSource
extends Object
implements ConfigurationSource

A composite configuration source that uses multiple configuration sources to resolve configuration properties.

A composite configuration source uses a CompositeConfigurationStrategy to determine the best matching value among the different sources for a given query.

A composite configuration source queries its sources in sequence. It first applies a new CompositeConfigurationStrategy.CompositeDefaultingStrategy provided by CompositeConfigurationStrategy.createDefaultingStrategy() to the sources that implement DefaultableConfigurationSource. This allows to specify a defaulting strategy when executing queries on each sources. The composite defaulting strategy allows to reduce the queries to execute on each source by keeping track of intermediate results in each round.

Configuration sources are ordered from the highest to lowest priority, the strategy allows to specify whether a result returned by a source for a given query supersedes the result returned in a previous round for the same query (see CompositeConfigurationStrategy.isSuperseded(io.inverno.mod.configuration.ConfigurationKey, io.inverno.mod.configuration.ConfigurationKey, io.inverno.mod.configuration.ConfigurationKey)).

At the end of each round, the strategy is used to determine whether a result resolves a query (see CompositeConfigurationStrategy.isResolved(io.inverno.mod.configuration.ConfigurationKey, io.inverno.mod.configuration.ConfigurationKey)), in which case the query is removed from the list of queries to execute on subsequent sources.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• ConfigurationSource
• CompositeConfigurationStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompositeConfigurationSource.CompositeConfigurationQuery	The configuration query used by the composite configuration source.
static class	CompositeConfigurationSource.CompositeConfigurationQueryResult	The configuration query result returned by a composite configuration source.
static class	CompositeConfigurationSource.CompositeExecutableConfigurationQuery	The executable configuration query used by the composite configuration source.
static class	CompositeConfigurationSource.CompositeListConfigurationQuery	The list configuration query used by the composite configuration source.

Constructor Summary

Constructors

Constructor	Description
CompositeConfigurationSource(List<ConfigurationSource> sources)	Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which uses the default CompositeConfigurationStrategy.lookup() strategy.
CompositeConfigurationSource(List<ConfigurationSource> sources, CompositeConfigurationStrategy strategy)	Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which uses the specified strategy.
CompositeConfigurationSource(List<ConfigurationSource> sources, List<ConfigurationKey.Parameter> defaultParameters)	Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which applies the specified default parameters and uses the default CompositeConfigurationStrategy.lookup() strategy.
CompositeConfigurationSource(List<ConfigurationSource> sources, List<ConfigurationKey.Parameter> defaultParameters, CompositeConfigurationStrategy strategy)	Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which applies the specified default parameters and uses the specified strategy.

Method Summary

Modifier and Type	Method	Description
CompositeConfigurationSource.CompositeExecutableConfigurationQuery	get(String... names)	Creates a configuration query to retrieve the specified properties.
List<ConfigurationSource>	getSources()	Returns the list of configuration sources from the highest priority to the lowest.
CompositeConfigurationStrategy	getStrategy()	Returns the composite configuration strategy.
CompositeConfigurationSource.CompositeListConfigurationQuery	list(String name)	Creates a list configuration query to list configuration properties defined with the specified property name.
void	setStrategy(CompositeConfigurationStrategy strategy)	Sets the composite configuration strategy.
CompositeConfigurationSource	unwrap()	Returns the original configuration source.
final CompositeConfigurationSource	withParameters(ConfigurationKey.Parameter... parameters)	Defines parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1)	Defines one parameter that specifies the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2)	Defines two parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3)	Defines three parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4)	Defines four parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5)	Defines five parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6)	Defines six parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7)	Defines seven parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8)	Defines eighth parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8, String k9, Object v9)	Defines nine parameters that specify the context in which configuration properties are to be retrieved.
final CompositeConfigurationSource	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8, String k9, Object v9, String k10, Object v10)	Defines ten parameters that specify the context in which configuration properties are to be retrieved.
CompositeConfigurationSource	withParameters(List<ConfigurationKey.Parameter> parameters)	Defines parameters that specify the context in which configuration properties are to be retrieved.

Methods inherited from class java.lang.Object

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

Constructor Details

CompositeConfigurationSource

public CompositeConfigurationSource(List<ConfigurationSource> sources)

Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which uses the default CompositeConfigurationStrategy.lookup() strategy.

Parameters:

sources - a list of configuration sources

CompositeConfigurationSource

public CompositeConfigurationSource(List<ConfigurationSource> sources,
 List<ConfigurationKey.Parameter> defaultParameters)

Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which applies the specified default parameters and uses the default CompositeConfigurationStrategy.lookup() strategy.

Parameters:

sources - a list of configuration sources

defaultParameters - the default parameters to apply

CompositeConfigurationSource

public CompositeConfigurationSource(List<ConfigurationSource> sources,
 CompositeConfigurationStrategy strategy)

Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which uses the specified strategy.

Parameters:

sources - a list of configuration sources

strategy - a composite configuration strategy

CompositeConfigurationSource

public CompositeConfigurationSource(List<ConfigurationSource> sources,
 List<ConfigurationKey.Parameter> defaultParameters,
 CompositeConfigurationStrategy strategy)

Creates a new composite configuration source with the specified sources ordered from the highest to lowest priority which applies the specified default parameters and uses the specified strategy.

Parameters:

sources - a list of configuration sources

defaultParameters - the default parameters to apply

strategy - a composite configuration strategy

Method Details

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1)

Description copied from interface: ConfigurationSource

Defines one parameter that specifies the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the parameter name

v1 - the parameter value

Returns:

the executable configuration query

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines two parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines three parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines four parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines five parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines six parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines seven parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7,
 String k8,
 Object v8)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines eighth parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

k8 - the eighth parameter name

v8 - the eighth parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7,
 String k8,
 Object v8,
 String k9,
 Object v9)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines nine parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

k8 - the eighth parameter name

v8 - the eighth parameter value

k9 - the ninth parameter name

v9 - the ninth parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7,
 String k8,
 Object v8,
 String k9,
 Object v9,
 String k10,
 Object v10)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines ten parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

k8 - the eighth parameter name

v8 - the eighth parameter value

k9 - the ninth parameter name

v9 - the ninth parameter value

k10 - the tenth parameter name

v10 - the tenth parameter value

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public final CompositeConfigurationSource withParameters(ConfigurationKey.Parameter... parameters)
                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

parameters - an array of parameters

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

public CompositeConfigurationSource withParameters(List<ConfigurationKey.Parameter> parameters)
                                            throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Parameters:

parameters - a list of parameters

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

unwrap

public CompositeConfigurationSource unwrap()

Description copied from interface: ConfigurationSource

Returns the original configuration source.

A configuration source can be decorated in order to provide a fixed set of parameters for all queries or to use a particular DefaultingStrategy when considering a DefaultableConfigurationSource. This method helps retrieving the original source (i.e. before any transformations).

Specified by:

unwrap in interface ConfigurationSource

Returns:

the original configuration or this configuration

getSources

public List<ConfigurationSource> getSources()

Returns the list of configuration sources from the highest priority to the lowest.

Returns:

a list of configuration sources

getStrategy

public CompositeConfigurationStrategy getStrategy()

Returns the composite configuration strategy.

Returns:

the composite configuration strategy

setStrategy

public void setStrategy(CompositeConfigurationStrategy strategy)
                 throws NullPointerException

Sets the composite configuration strategy.

Parameters:

strategy - a strategy

Throws:

NullPointerException - if the strategy is null

get

public CompositeConfigurationSource.CompositeExecutableConfigurationQuery get(String... names)
                                                                       throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Creates a configuration query to retrieve the specified properties.

Specified by:

get in interface ConfigurationSource

Parameters:

names - an array of property names

Returns:

an executable configuration query

Throws:

IllegalArgumentException - if the array of names is null or empty

list

public CompositeConfigurationSource.CompositeListConfigurationQuery list(String name)
                                                                  throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Creates a list configuration query to list configuration properties defined with the specified property name.

Specified by:

list in interface ConfigurationSource

Parameters:

name - a property name

Returns:

a list configuration query

Throws:

IllegalArgumentException - if the name is null or empty