org.apache.deltaspike.core.api.config

Class ConfigResolver

java.lang.Object

org.apache.deltaspike.core.api.config.ConfigResolver

@Typed
public final class ConfigResolver
extends Object

Resolve the configuration via their well defined ordinals.

You can provide your own lookup paths by implementing and registering additional PropertyFileConfig or ConfigSource or ConfigSourceProvider implementations.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addConfigSources(List<ConfigSource> configSourcesToAdd) This method can be used for programmatically adding ConfigSources.
static void	freeConfigSources() Clear all ConfigSources for the current ClassLoader
static Map<String,String>	getAllProperties()
static List<String>	getAllPropertyValues(String key) Resolve all values for the given key, from all registered ConfigSources ordered by their ordinal value in ascending ways.
static String	getPropertyValue(String key) Resolve the property value by going through the list of configured ConfigSources and use the one with the highest priority.
static String	getPropertyValue(String key, String defaultValue) Resolve the property value by going through the list of configured ConfigSources and use the one with the highest priority.

Methods inherited from class java.lang.Object

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

Method Detail

addConfigSources

public static void addConfigSources(List<ConfigSource> configSourcesToAdd)

This method can be used for programmatically adding ConfigSources. It is not needed for normal 'usage' by end users, but only for Extension Developers!

Parameters:

configSourcesToAdd - the ConfigSources to add

freeConfigSources

public static void freeConfigSources()

Clear all ConfigSources for the current ClassLoader

getPropertyValue

public static String getPropertyValue(String key,
                      String defaultValue)

Resolve the property value by going through the list of configured ConfigSources and use the one with the highest priority. If no configured value has been found that way we will use the defaultValue.

Parameters:

key - the property key.

defaultValue - will be used if no configured value for the key could be found.

Returns:

the configured property value from the ConfigSource with the highest ordinal or the defaultValue if there is no value explicitly configured.

getPropertyValue

public static String getPropertyValue(String key)

Resolve the property value by going through the list of configured ConfigSources and use the one with the highest priority.

Parameters:

key - the property key.

Returns:

the configured property value from the ConfigSource with the highest ordinal or null if there is no configured value for it.

getAllPropertyValues

public static List<String> getAllPropertyValues(String key)

Resolve all values for the given key, from all registered ConfigSources ordered by their ordinal value in ascending ways. If more ConfigSources have the same ordinal, their order is undefined.

Parameters:

key - under which configuration is stored

Returns:

List with all found property values, sorted in ascending order of their ordinal.

See Also:

ConfigSource.getOrdinal()

getAllProperties

public static Map<String,String> getAllProperties()