org.jolokia.config

Class Configuration

java.lang.Object

org.jolokia.config.Configuration

public class Configuration
extends Object

Class encapsulating all Agent configuration, global config and processing parameters

Since:

07.02.13

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_QUERY_PARAM

Constructor Summary

Constructors

Constructor and Description
Configuration(Object... keyAndValues) Convenience constructor for setting up base configuration with key values pairs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(ConfigKey pKey) Check whether a key is explicitely provided
String	get(ConfigKey pKey) Get a configuration value if set as configuration or the default value if not
boolean	getAsBoolean(ConfigKey pKey) Get an configuration value as boolean value.
int	getAsInt(ConfigKey pKey) Get an configuration value as int value
ProcessingParameters	getProcessingParameters(Map<String,String> pParams) Get processing parameters from a string-string map
int	size() Get the number of stored configuration values
void	updateGlobalConfiguration(ConfigExtractor pExtractor) Update the configuration hold by this object
void	updateGlobalConfiguration(Map<String,String> pConfig) Update this global configuration from a string-string.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_QUERY_PARAM

public static final String PATH_QUERY_PARAM

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration(Object... keyAndValues)

Convenience constructor for setting up base configuration with key values pairs. This constructor is especially suited for unit tests.

Parameters:

keyAndValues - an array with even number of elements and ConfigKey and String alternating

Method Detail

updateGlobalConfiguration

public void updateGlobalConfiguration(ConfigExtractor pExtractor)

Update the configuration hold by this object

Parameters:

pExtractor - an extractor for retrieving the configuration from some external object

updateGlobalConfiguration

public void updateGlobalConfiguration(Map<String,String> pConfig)

Update this global configuration from a string-string. Only the known keys are taken from this map

Parameters:

pConfig - config map from where to take the configuration

get

public String get(ConfigKey pKey)

Get a configuration value if set as configuration or the default value if not

Parameters:

pKey - the configuration key to lookup

Returns:

the configuration value or the default value if no configuration was given.

getAsInt

public int getAsInt(ConfigKey pKey)

Get an configuration value as int value

Parameters:

pKey - the configuration key

Returns:

the value set or, if not, the default value

getProcessingParameters

public ProcessingParameters getProcessingParameters(Map<String,String> pParams)

Get processing parameters from a string-string map

Parameters:

pParams - params to extra. A parameter "p" is used as extra path info

Returns:

the processing parameters

getAsBoolean

public boolean getAsBoolean(ConfigKey pKey)

Get an configuration value as boolean value. The value must be configured as 'true' for this method to return true

Parameters:

pKey - the configuration key for which a boolean config value is requested

Returns:

true if the configuration (or the default value, if the configuration is not set) is "true" for this key, false otherwise.

size

public int size()

Get the number of stored configuration values

Returns:

number of configuration values

containsKey

public boolean containsKey(ConfigKey pKey)

Check whether a key is explicitely provided

Parameters:

pKey - key to check

Returns:

true if the key is contained in the configuration, false otherwise