org.drombler.commons.client.startup.main

Class DromblerClientConfiguration

java.lang.Object

org.drombler.commons.client.startup.main.DromblerClientConfiguration

public class DromblerClientConfiguration
extends Object

The client configuration. Subclasses may add additional properties or change the configuration such as the application layout.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_DIRECTORY_NAME Name of the configuration directory.
static String	CONFIG_PROPERTIES_FILE_NAME The default name used for the configuration properties file.
static String	CONFIG_PROPERTIES_PROP The property name used to specify an URL to the configuration property file to be used for the created the framework instance.
static String	SYSTEM_PROPERTIES_FILE_NAME The default name used for the system properties file.
static String	SYSTEM_PROPERTIES_PROP The property name used to specify an URL to the system property file.
static String	USER_DIR_PROPERTY The property name of the user dir property in the config.properties file expected at <install-dir>/conf.

Constructor Summary

Constructors

Constructor and Description
DromblerClientConfiguration(CommandLineArgs commandLineArgs) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
protected void	copySystemProperties(Properties configProps) Copies and sets some additional system properties.
protected Path	determineInstallDirPath(Path mainJarPath) Determines the installation directory path of this application.
ApplicationConfiguration	getApplicationConfig() Gets the application configuration packaged with the application.
CommandLineArgs	getCommandLineArgs() Gets the command line args.
Path	getInstallConfigDirPath() Gets the path to the configuration directory in the installation directory of this application.
Path	getInstallDirPath() Gets the installation directory path of this application.
Path	getUserConfigDirPath() Gets the path to the configuration directory in the user directory of the current user for this application.
Properties	getUserConfigProps() Gets the user configuration properties.
Path	getUserDirPath() Gets the user directory path.
protected Properties	loadDefaultConfigProps() Loads the default configuration properties.
protected void	loadSystemProperties(Path rootDirPath) Loads and sets the system properties.
protected void	resolveProperties(Properties configProps) Resolves properties with variables.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_PROPERTIES_PROP

public static final String SYSTEM_PROPERTIES_PROP

The property name used to specify an URL to the system property file.

See Also:

Constant Field Values

SYSTEM_PROPERTIES_FILE_NAME

public static final String SYSTEM_PROPERTIES_FILE_NAME

The default name used for the system properties file.

See Also:

Constant Field Values

CONFIG_DIRECTORY_NAME

public static final String CONFIG_DIRECTORY_NAME

Name of the configuration directory.

See Also:

Constant Field Values

CONFIG_PROPERTIES_PROP

public static final String CONFIG_PROPERTIES_PROP

The property name used to specify an URL to the configuration property file to be used for the created the framework instance.

See Also:

Constant Field Values

CONFIG_PROPERTIES_FILE_NAME

public static final String CONFIG_PROPERTIES_FILE_NAME

The default name used for the configuration properties file.

See Also:

Constant Field Values

USER_DIR_PROPERTY

public static final String USER_DIR_PROPERTY

The property name of the user dir property in the config.properties file expected at <install-dir>/conf.

See Also:

Constant Field Values

Constructor Detail

DromblerClientConfiguration

public DromblerClientConfiguration(CommandLineArgs commandLineArgs)
                            throws URISyntaxException,
                                   IOException,
                                   MissingPropertyException

Creates a new instance of this class.

Parameters:

commandLineArgs - the command line args

Throws:

URISyntaxException

IOException

MissingPropertyException

Method Detail

determineInstallDirPath

protected Path determineInstallDirPath(Path mainJarPath)

Determines the installation directory path of this application. The default implementation expects the following application installation layout: <install-dir>/lib/<jar>

Parameters:

mainJarPath - the path to the JAR file containing the main starter

Returns:

the installation directory path of this application

loadSystemProperties

protected void loadSystemProperties(Path rootDirPath)
                             throws MalformedURLException,
                                    IOException

Loads and sets the system properties.

Parameters:

rootDirPath - the root dir path

Throws:

MalformedURLException

IOException

loadDefaultConfigProps

protected Properties loadDefaultConfigProps()
                                     throws IOException

Loads the default configuration properties.

Returns:

the default configuration properties

Throws:

IOException

copySystemProperties

protected void copySystemProperties(Properties configProps)

Copies and sets some additional system properties. The default implementation does not copy any additional system properties.

Parameters:

configProps - the source properties to copy to

resolveProperties

protected void resolveProperties(Properties configProps)

Resolves properties with variables. The default implementation does nothing currently.

Parameters:

configProps - the properties to resolve

getInstallDirPath

public final Path getInstallDirPath()

Gets the installation directory path of this application.

Returns:

the installation directory path of this application

getInstallConfigDirPath

public final Path getInstallConfigDirPath()

Gets the path to the configuration directory in the installation directory of this application.

Returns:

the path to the configuration directory in the installation directory of this application

getUserDirPath

public final Path getUserDirPath()

Gets the user directory path.

Returns:

the user directory path

getUserConfigDirPath

public final Path getUserConfigDirPath()

Gets the path to the configuration directory in the user directory of the current user for this application.

Returns:

the path to the configuration directory in the user directory of the current user for this application

getUserConfigProps

public Properties getUserConfigProps()

Gets the user configuration properties.

Returns:

the user configuration properties

getCommandLineArgs

public CommandLineArgs getCommandLineArgs()

Gets the command line args.

Returns:

the command line args

getApplicationConfig

public ApplicationConfiguration getApplicationConfig()

Gets the application configuration packaged with the application.

Returns:

the application configuration