org.ow2.chameleon.core

Class ChameleonConfiguration

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,String>

org.ow2.chameleon.core.ChameleonConfiguration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>

public class ChameleonConfiguration
extends HashMap<String,String>

Manages the configuration of the OSGi framework and of the chameleon container and services.

Version:

$Id: 1.0.4 $Id

Author:

The OW2 Chameleon Team

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ChameleonConfiguration(File baseDirectory) Constructor for ChameleonConfiguration.

Method Summary

Modifier and Type	Method and Description
String	get(String key, String defaultValue) Retrieves the value from the configuration.
File	getBaseDirectory() Gets the base directory.
boolean	getBoolean(String key, boolean defaultValue) Retrieves the value from the configuration.
File	getDirectory(String key, boolean create) Retrieves a directory from the configuration.
File	getFile(String key, boolean create) Retrieves a file from the configuration.
int	getInt(String key, int defaultValue) Retrieves the value from the configuration.
File	getRelativeFile(String path) Gets a relative file from the the base directory.
void	initFrameworkConfiguration() Initializes the framework configuration.
void	initialize(Map<String,Object> userProperties) Initializes the configuration.
boolean	isInteractiveModeEnabled() Is the interactive mode enabled?
void	loadChameleonProperties() Loads the chameleon properties file.
void	loadSystemProperties() Loads system properties.
void	loadSystemPropertiesSpecifiedByTheUser(Map<String,Object> userProperties) Loads the system properties specified by the user.
String	scanLibsDirectory() Scans the jar file of the 'libs' directory to retrieve the packages to be exported.
void	setInteractiveModeEnabled(boolean interactiveModeEnabled) enables/ disables the interactive mode.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

ChameleonConfiguration

public ChameleonConfiguration(File baseDirectory)

Constructor for ChameleonConfiguration.

Parameters:

baseDirectory - a File object.

Method Detail

initialize

public void initialize(Map<String,Object> userProperties)
                throws IOException

Initializes the configuration.

Parameters:

userProperties - a Map object.

Throws:

IOException - if any.

loadChameleonProperties

public void loadChameleonProperties()
                             throws IOException

Loads the chameleon properties file.

Throws:

IOException - if any.

get

public String get(String key,
                  String defaultValue)

Retrieves the value from the configuration.

Parameters:

key - the key

defaultValue - the default value if the key is not present in the configuration

Returns:

the stored value or the default value if none

getDirectory

public File getDirectory(String key,
                         boolean create)

Retrieves a directory from the configuration. A file object build from the stored value and relative from the base directory is returned. If the 'create' flag is enabled, the directory is created.

Parameters:

key - the key associated to the directory name

create - create the directory if it does not exist

Returns:

the file object

getBoolean

public boolean getBoolean(String key,
                          boolean defaultValue)

Retrieves the value from the configuration.

Parameters:

key - the key

defaultValue - the default value if the key is not present in the configuration

Returns:

the stored value or the default value if none

getInt

public int getInt(String key,
                  int defaultValue)

Retrieves the value from the configuration.

Parameters:

key - the key

defaultValue - the default value if the key is not present in the configuration

Returns:

the stored value or the default value if none

getFile

public File getFile(String key,
                    boolean create)

Retrieves a file from the configuration. A file object build from the stored value and relative from the base directory is returned. If the 'create' flag is enabled, the file is created.

Parameters:

key - the key associated to the file name

create - create the file if it does not exist

Returns:

the file object

initFrameworkConfiguration

public void initFrameworkConfiguration()

Initializes the framework configuration.

loadSystemProperties

public void loadSystemProperties()
                          throws IOException

Loads system properties.

Throws:

IOException - if the system.properties file cannot be read.

getBaseDirectory

public File getBaseDirectory()

Gets the base directory.

Returns:

the base directory

isInteractiveModeEnabled

public boolean isInteractiveModeEnabled()

Is the interactive mode enabled?

Returns:

true if the interactive mode is enabled, false otherwise

setInteractiveModeEnabled

public void setInteractiveModeEnabled(boolean interactiveModeEnabled)

enables/ disables the interactive mode.

Parameters:

interactiveModeEnabled - whether or not the interactive mode has to be enabled.

getRelativeFile

public File getRelativeFile(String path)

Gets a relative file from the the base directory.

Parameters:

path - the path to the file.

Returns:

the file object

loadSystemPropertiesSpecifiedByTheUser

public void loadSystemPropertiesSpecifiedByTheUser(Map<String,Object> userProperties)

Loads the system properties specified by the user.

Parameters:

userProperties - the properties set by the user from the command line.

scanLibsDirectory

public String scanLibsDirectory()

Scans the jar file of the 'libs' directory to retrieve the packages to be exported.

Returns:

the packages contained in the jars located in the 'libs' directory