io.inversion.utils

Class Config

java.lang.Object

io.inversion.utils.Config

public class Config
extends java.lang.Object

Global configuration properties access through a singleton wrapper around a Commons Configuration CompositeConfiguration object.

The name/value pairs found in configuration are used by the Configurator to reflectively set bean properties on Apis, Endpoints, Actions, Dbs and other Api model objects during Engine startup.

Automatic/reflective parameter setting via the Configurator is the preferred way to do runtime dependency injection. You can however directly use this classes Config.getXYX() methods to look up key/value pairs at runtime.

You can access and modify the underlying CompositeConfiguration object to change where properties are pulled form.

By default, listed in order of priority, properties are merged from:

1. a "${user.dir}/.env" properties file if one exists.
2. system properties
3. environment variables
4. ${configPath}/inversion[-][0-100]-${configProfile}.properties files if they exist
5. ${configPath}/inversion-${configProfile}[-][0-100].properties files if they exist
6. ${configPath}/inversion[-][0-100].properties files if they exist

For example:

• if key "foo" is found in "${user.dir}/.env" the corresponding value will always be returned no matter what other source have key "foo"
• if key "bar" exists in inversion-${configProfile}.properties and inversion.properties, the value from inversion-${configProfile}.properties will be returned
• if key "abc" is environment and inversion-${configProfile}.properties, the value from the environment will be returned
• if key "xyz" is in inversion.properties and inversion-10.properties, the value from inversion-10.properties will be returned

If you have a custom configuration data source, such as a database or secrets key vault, you can add those to the FRONT of the CompositeConfiguration via Config.getConfiguration().addConfigurationFirst(MY_CONFIG_OBJECT) to make sure those values are given the highest priority. Use CompositeConfiguration.addConfiguration to give your custom props lowest priority.

See Also:

Configurator, org.apache.commons.configuration2.CombinedConfiguration

Method Summary

Modifier and Type	Method and Description
static void	clearConfiguration() Nulls out the system wide CompositeConfiguration, same as setConfiguration(null)
protected static java.net.URL	findUrl(java.lang.String name) Attempts to locate a resource URL for name via the ClassLoader or as a file path relative to ${user.dir}.
static java.math.BigDecimal	getBigDecimal(java.lang.String key)
static java.math.BigDecimal	getBigDecimal(java.lang.String key, java.math.BigDecimal defaultValue)
static java.math.BigInteger	getBigInteger(java.lang.String key)
static java.math.BigInteger	getBigInteger(java.lang.String key, java.math.BigInteger defaultValue)
static boolean	getBoolean(java.lang.String key)
static boolean	getBoolean(java.lang.String key, boolean defaultValue)
static java.lang.Boolean	getBoolean(java.lang.String key, java.lang.Boolean defaultValue)
static byte	getByte(java.lang.String key)
static byte	getByte(java.lang.String key, byte defaultValue)
static java.lang.Byte	getByte(java.lang.String key, java.lang.Byte defaultValue)
static org.apache.commons.configuration2.CompositeConfiguration	getConfiguration() If configuration is null, loadConfiguration is called to lazy load the default config.
static double	getDouble(java.lang.String key)
static double	getDouble(java.lang.String key, double defaultValue)
static java.lang.Double	getDouble(java.lang.String key, java.lang.Double defaultValue)
static float	getFloat(java.lang.String key)
static float	getFloat(java.lang.String key, float defaultValue)
static java.lang.Float	getFloat(java.lang.String key, java.lang.Float defaultValue)
static int	getInt(java.lang.String key)
static int	getInt(java.lang.String key, int defaultValue)
static java.lang.Integer	getInteger(java.lang.String key, java.lang.Integer defaultValue)
static java.util.Iterator<java.lang.String>	getKeys()
static long	getLong(java.lang.String key)
static long	getLong(java.lang.String key, long defaultValue)
static java.lang.Long	getLong(java.lang.String key, java.lang.Long defaultValue)
static java.lang.Object	getProperty(java.lang.String key)
static short	getShort(java.lang.String key)
static short	getShort(java.lang.String key, short defaultValue)
static java.lang.Short	getShort(java.lang.String key, java.lang.Short defaultValue)
static java.lang.String	getString(java.lang.String key)
static java.lang.String	getString(java.lang.String key, java.lang.String defaultValue)
static boolean	hasConfiguration()
static void	loadConfiguration(java.lang.String configPath, java.lang.String configProfile) Creates a new CompositeConfiguration with individual Configuration objects loaded with key/value pairs from sources as described in the class comment above.
static void	setConfiguration(org.apache.commons.configuration2.CompositeConfiguration configuration) Sets the system wide CompositeConfiguration.

Methods inherited from class java.lang.Object

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

Method Detail

hasConfiguration

public static boolean hasConfiguration()

getConfiguration

public static org.apache.commons.configuration2.CompositeConfiguration getConfiguration()

If configuration is null, loadConfiguration is called to lazy load the default config.

Returns:

the system wide CompositeConfiguration

setConfiguration

public static void setConfiguration(org.apache.commons.configuration2.CompositeConfiguration configuration)

Sets the system wide CompositeConfiguration.

Generally, you don't need to explicitly call this, as accessing any of this classes getters will cause the default configuration to be loaded via loadConfiguration() if configuration is null.

Parameters:

configuration - the configuration to use

clearConfiguration

public static void clearConfiguration()

Nulls out the system wide CompositeConfiguration, same as setConfiguration(null)

loadConfiguration

public static void loadConfiguration(java.lang.String configPath,
                                     java.lang.String configProfile)

Creates a new CompositeConfiguration with individual Configuration objects loaded with key/value pairs from sources as described in the class comment above.

If configPath is null, it will be looked up via Utils.findProperty with the following keys:

1. "inversion.configPath"
2. "configPath"

If configProfile is null, it will be looked up via Utils.findProperty with the following keys:

1. "inversion.configProfile"
2. "inversion.profile"
3. "spring.profiles.active"
4. "configProfile"
5. "profile"

Parameters:

configPath - the path use to locate 'inversion.properties' files via getResource

configProfile - the runtime profile used to load some inversion-${configProfile}-[0-100].properties files and not others.

See Also:

findUrl(String), Utils.findSysEnvProp(String...)

findUrl

protected static java.net.URL findUrl(java.lang.String name)

Attempts to locate a resource URL for name via the ClassLoader or as a file path relative to ${user.dir}.

Parameters:

name - a string identifier for the resource to find

Returns:

a url

getKeys

public static java.util.Iterator<java.lang.String> getKeys()

getProperty

public static java.lang.Object getProperty(java.lang.String key)

getBoolean

public static boolean getBoolean(java.lang.String key)

getBoolean

public static boolean getBoolean(java.lang.String key,
                                 boolean defaultValue)

getBoolean

public static java.lang.Boolean getBoolean(java.lang.String key,
                                           java.lang.Boolean defaultValue)

getByte

public static byte getByte(java.lang.String key)

getByte

public static byte getByte(java.lang.String key,
                           byte defaultValue)

getByte

public static java.lang.Byte getByte(java.lang.String key,
                                     java.lang.Byte defaultValue)

getDouble

public static double getDouble(java.lang.String key)

getDouble

public static double getDouble(java.lang.String key,
                               double defaultValue)

getDouble

public static java.lang.Double getDouble(java.lang.String key,
                                         java.lang.Double defaultValue)

getFloat

public static float getFloat(java.lang.String key)

getFloat

public static float getFloat(java.lang.String key,
                             float defaultValue)

getFloat

public static java.lang.Float getFloat(java.lang.String key,
                                       java.lang.Float defaultValue)

getInt

public static int getInt(java.lang.String key)

getInt

public static int getInt(java.lang.String key,
                         int defaultValue)

getInteger

public static java.lang.Integer getInteger(java.lang.String key,
                                           java.lang.Integer defaultValue)

getLong

public static long getLong(java.lang.String key)

getLong

public static long getLong(java.lang.String key,
                           long defaultValue)

getLong

public static java.lang.Long getLong(java.lang.String key,
                                     java.lang.Long defaultValue)

getShort

public static short getShort(java.lang.String key)

getShort

public static short getShort(java.lang.String key,
                             short defaultValue)

getShort

public static java.lang.Short getShort(java.lang.String key,
                                       java.lang.Short defaultValue)

getBigDecimal

public static java.math.BigDecimal getBigDecimal(java.lang.String key)

getBigDecimal

public static java.math.BigDecimal getBigDecimal(java.lang.String key,
                                                 java.math.BigDecimal defaultValue)

getBigInteger

public static java.math.BigInteger getBigInteger(java.lang.String key)

getBigInteger

public static java.math.BigInteger getBigInteger(java.lang.String key,
                                                 java.math.BigInteger defaultValue)

getString

public static java.lang.String getString(java.lang.String key)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.String defaultValue)