co.codewizards.cloudstore.core.config

Class ConfigDir

java.lang.Object

co.codewizards.cloudstore.core.config.ConfigDir

public class ConfigDir
extends Object

ConfigDir represents the central configuration directory.

Besides the configuration, this directory holds all global (non-repository-related) files, including log files.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_PROPERTY_CONFIG_DIR System property controlling the location of the central configuration directory.
static String	SYSTEM_PROPERTY_LOG_DIR System property controlling the location of the log directory.

Method Summary

Methods

Modifier and Type	Method and Description
File	getFile() Gets the central configuration directory as absolute File.
static ConfigDir	getInstance() Gets the singleton instance of ConfigDir.
File	getLogDir() Gets the log directory (the directory where the log files are written to).
String	getValue() Gets the central configuration directory as String.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_PROPERTY_CONFIG_DIR

public static final String SYSTEM_PROPERTY_CONFIG_DIR

System property controlling the location of the central configuration directory.

If this system property is not set, it defaults to: /home/tomcat/.cloudstore

Note that this property is always set during runtime. If it is not set by the caller (via a -D JVM argument) from the outside, then it is set by the code inside the running application. Therefore, this property can be referenced in all configuration files where system properties are resolved (e.g. in the logback configuration).

See Also:

getValue(), getFile(), Constant Field Values

SYSTEM_PROPERTY_LOG_DIR

public static final String SYSTEM_PROPERTY_LOG_DIR

System property controlling the location of the log directory.

If this system property is not set, it defaults to: /home/tomcat/.cloudstore/log

Note that this property is always set during runtime. If it is not set by the caller (via a -D JVM argument) from the outside, then it is set by the code inside the running application. Therefore, this property can be referenced in all configuration files where system properties are resolved (e.g. in the logback configuration).

See Also:

getLogDir(), Constant Field Values

Method Detail

getInstance

public static ConfigDir getInstance()

Gets the singleton instance of ConfigDir.

Returns:

the singleton instance of ConfigDir. Never null.

getValue

public String getValue()

Gets the central configuration directory as String.

This is the non-resolved (as is) value of the system property SYSTEM_PROPERTY_CONFIG_DIR. Even if this property was not set (from the outside), it is initialised by default to: /home/tomcat/.cloudstore

Returns:

the central configuration directory as String. Never null.

See Also:

SYSTEM_PROPERTY_CONFIG_DIR, getFile()

getFile

public File getFile()

Gets the central configuration directory as absolute File.

In contrast to getValue(), this file's path is resolved; i.e. all system properties occurring in it (e.g. "/home/tomcat") were replaced by their actual values.

Returns:

the central configuration directory as absolute File. Never null.

See Also:

SYSTEM_PROPERTY_CONFIG_DIR, getValue()

getLogDir

public File getLogDir()

Gets the log directory (the directory where the log files are written to).

This directory can be configured or referenced (e.g. in a logback configuation file) via SYSTEM_PROPERTY_LOG_DIR.

Returns:

the log directory. Never null.

See Also:

SYSTEM_PROPERTY_LOG_DIR