Package com.github.cafapi.common.bootstrapconfigs.system

Class SystemBootstrapConfiguration

java.lang.Object

com.github.cafapi.common.bootstrapconfigs.system.SystemBootstrapConfiguration

All Implemented Interfaces:

BootstrapConfiguration

public class SystemBootstrapConfiguration
extends Object
implements BootstrapConfiguration

Provides bootstrap configuration from Java system properties and environment variables. Note that system properties will always override if present.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENV_MARATHON_APP_ID

Fields inherited from interface com.github.cafapi.common.api.BootstrapConfiguration

CONFIG_APP_NAME, OLD_CONFIG_APP_NAME

Constructor Summary

Constructors

Constructor	Description
SystemBootstrapConfiguration()

Method Summary

Modifier and Type	Method	Description
String	getConfiguration(String key)	Return the value of the requested configuration parameter.
boolean	getConfigurationBoolean(String key)	Return the boolean representation of the requested configuration parameter.
int	getConfigurationInteger(String key)	Return the integer representation of the requested configuration parameter.
int	getConfigurationInteger(String key, int min, int max)	Return the integer representation of the requested configuration parameter, between the minimum and maximum integers specified.
ServicePath	getServicePath()
boolean	isConfigurationPresent(String key)	Determine if a configuration parameter has been set or not.

Methods inherited from class java.lang.Object

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

Field Details

ENV_MARATHON_APP_ID

public static final String ENV_MARATHON_APP_ID

See Also:

• Constant Field Values

Constructor Details

SystemBootstrapConfiguration

public SystemBootstrapConfiguration()

Method Details

isConfigurationPresent

public boolean isConfigurationPresent(String key)

Description copied from interface: BootstrapConfiguration

Determine if a configuration parameter has been set or not.

Specified by:

isConfigurationPresent in interface BootstrapConfiguration

Parameters:

key - the config parameter to check

Returns:

whether the config parameter is set or not

getConfiguration

public String getConfiguration(String key)
                        throws ConfigurationException

Description copied from interface: BootstrapConfiguration

Return the value of the requested configuration parameter.

Specified by:

getConfiguration in interface BootstrapConfiguration

Parameters:

key - the config parameter to lookup

Returns:

the value of the config parameter

Throws:

ConfigurationException - if the configuration parameter is not set

getConfigurationInteger

public int getConfigurationInteger(String key)
                            throws ConfigurationException

Description copied from interface: BootstrapConfiguration

Return the integer representation of the requested configuration parameter.

Specified by:

getConfigurationInteger in interface BootstrapConfiguration

Parameters:

key - the config parameter to lookup

Returns:

the value of the config parameter as an integer

Throws:

ConfigurationException - if the configuration parameter is not set

getConfigurationInteger

public int getConfigurationInteger(String key,
 int min,
 int max)
                            throws ConfigurationException

Description copied from interface: BootstrapConfiguration

Return the integer representation of the requested configuration parameter, between the minimum and maximum integers specified.

Specified by:

getConfigurationInteger in interface BootstrapConfiguration

Parameters:

key - the config parameter to lookup

min - the lower bound of the integer to be returned

max - the upper bound of the integer to be returned

Returns:

the value of the config parameter as an integer, between the limits specified

Throws:

ConfigurationException - if the configuration parameter is not set

getConfigurationBoolean

public boolean getConfigurationBoolean(String key)
                                throws ConfigurationException

Description copied from interface: BootstrapConfiguration

Return the boolean representation of the requested configuration parameter.

Specified by:

getConfigurationBoolean in interface BootstrapConfiguration

Parameters:

key - the config parameter to lookup

Returns:

the value of the config parameter as an integer

Throws:

ConfigurationException - if the configuration parameter is not set

getServicePath

public ServicePath getServicePath()
                           throws ConfigurationException

Specified by:

getServicePath in interface BootstrapConfiguration

Returns:

an object representing the fully qualified service path of this instance

Throws:

ConfigurationException - if the ServicePath cannot be acquired