org.dspace.core

Class ConfigurationManager

java.lang.Object

org.dspace.core.ConfigurationManager

public class ConfigurationManager
extends java.lang.Object

Class for reading the DSpace system configuration. The main configuration is read in as properties from a standard properties file.

The main configuration is by default read from the resource /dspace.cfg. To specify a different configuration, the system property dspace.configuration should be set to the filename of the configuration file.

Other configuration files are read from the config directory of the DSpace installation directory (specified as the property dspace.dir in the main configuration file.)

Version:

$Revision$

Author:

Robert Tansley, Larry Stone - Interpolated values., Mark Diggory - General Improvements to detection, logging and loading.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationManager()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	getBooleanProperty(java.lang.String property) Get a configuration property as a boolean.
static boolean	getBooleanProperty(java.lang.String property, boolean defaultValue) Get a configuration property as a boolean, with default.
static boolean	getBooleanProperty(java.lang.String module, java.lang.String property) Get a module configuration property as a boolean.
static boolean	getBooleanProperty(java.lang.String module, java.lang.String property, boolean defaultValue) Get a module configuration property as a boolean, with default.
protected static java.io.File	getConfigurationFile() Deprecated. Please remove all direct usage of the configuration file.
static java.lang.String	getDefaultSubmissionLicense() Deprecated. since 4.0
static int	getIntProperty(java.lang.String property) Get a configuration property as an integer
static int	getIntProperty(java.lang.String property, int defaultValue) Get a configuration property as an integer, with default
static int	getIntProperty(java.lang.String module, java.lang.String property) Get a module configuration property as an integer
static int	getIntProperty(java.lang.String module, java.lang.String property, int defaultValue) Get a module configuration property as an integer, with default
static java.lang.String	getLicenseText(java.lang.String licenseFile) Deprecated. since 4.0
static long	getLongProperty(java.lang.String property) Get a configuration property as a long
static long	getLongProperty(java.lang.String property, int defaultValue) Get a configuration property as an long, with default
static long	getLongProperty(java.lang.String module, java.lang.String property) Get a module configuration property as a long
static long	getLongProperty(java.lang.String module, java.lang.String property, int defaultValue) Get a configuration property as an long, with default
static java.lang.String	getNewsFilePath() Deprecated. since 4.0
static java.util.Properties	getProperties() Returns all properties in main configuration
static java.util.Properties	getProperties(java.lang.String module) Returns all properties for a given module
static java.lang.String	getProperty(java.lang.String property) Get a configuration property
static java.lang.String	getProperty(java.lang.String module, java.lang.String property) Get a module configuration property value.
static boolean	isConfigured() Identify if DSpace is properly configured
static boolean	isConfigured(java.lang.String module)
static void	loadConfig(java.lang.String configFile) Load the DSpace configuration properties.
static void	main(java.lang.String[] argv) Command-line interface for running configuration tasks.
static java.util.Enumeration<?>	propertyNames() Returns an enumeration of all the keys in the DSpace configuration
static java.util.Enumeration<?>	propertyNames(java.lang.String module) Returns an enumeration of all the keys in a module configuration
static java.lang.String	readNewsFile(java.lang.String name) Deprecated. since 4.0
static void	writeLicenseFile(java.lang.String licenseFile, java.lang.String newLicense) Deprecated. since 4.0
static java.lang.String	writeNewsFile(java.lang.String file, java.lang.String news) Deprecated. since 4.0

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationManager

protected ConfigurationManager()

Method Detail

isConfigured

public static boolean isConfigured()

Identify if DSpace is properly configured

Returns:

boolean true if configured, false otherwise

isConfigured

public static boolean isConfigured(java.lang.String module)

getProperties

public static java.util.Properties getProperties()

Returns all properties in main configuration

Returns:

properties - all non-modular properties

getProperties

public static java.util.Properties getProperties(java.lang.String module)

Returns all properties for a given module

Parameters:

module - the name of the module

Returns:

properties - all module's properties

getProperty

public static java.lang.String getProperty(java.lang.String property)

Get a configuration property

Parameters:

property - the name of the property

Returns:

the value of the property, or null if the property does not exist.

getProperty

public static java.lang.String getProperty(java.lang.String module,
                           java.lang.String property)

Get a module configuration property value.

Parameters:

module - the name of the module, or null for regular configuration property

property - the name (key) of the property

Returns:

the value of the property, or null if the property does not exist

getIntProperty

public static int getIntProperty(java.lang.String property)

Get a configuration property as an integer

Parameters:

property - the name of the property

Returns:

the value of the property. 0 is returned if the property does not exist. To differentiate between this case and when the property actually is zero, use getProperty.

getIntProperty

public static int getIntProperty(java.lang.String module,
                 java.lang.String property)

Get a module configuration property as an integer

Parameters:

module - the name of the module

property - the name of the property

Returns:

the value of the property. 0 is returned if the property does not exist. To differentiate between this case and when the property actually is zero, use getProperty.

getIntProperty

public static int getIntProperty(java.lang.String property,
                 int defaultValue)

Get a configuration property as an integer, with default

Parameters:

property - the name of the property

defaultValue - value to return if property is not found or is not an Integer.

Returns:

the value of the property. default is returned if the property does not exist or is not an Integer. To differentiate between this case and when the property actually is false, use getProperty.

getIntProperty

public static int getIntProperty(java.lang.String module,
                 java.lang.String property,
                 int defaultValue)

Get a module configuration property as an integer, with default

Parameters:

module - the name of the module

property - the name of the property

defaultValue - value to return if property is not found or is not an Integer.

Returns:

the value of the property. default is returned if the property does not exist or is not an Integer. To differentiate between this case and when the property actually is false, use getProperty.

getLongProperty

public static long getLongProperty(java.lang.String property)

Get a configuration property as a long

Parameters:

property - the name of the property

Returns:

the value of the property. 0 is returned if the property does not exist. To differentiate between this case and when the property actually is zero, use getProperty.

getLongProperty

public static long getLongProperty(java.lang.String module,
                   java.lang.String property)

Get a module configuration property as a long

Parameters:

module - the name of the module

property - the name of the property

Returns:

the value of the property. 0 is returned if the property does not exist. To differentiate between this case and when the property actually is zero, use getProperty.

getLongProperty

public static long getLongProperty(java.lang.String property,
                   int defaultValue)

Get a configuration property as an long, with default

Parameters:

property - the name of the property

defaultValue - value to return if property is not found or is not a Long.

Returns:

the value of the property. default is returned if the property does not exist or is not an Integer. To differentiate between this case and when the property actually is false, use getProperty.

getLongProperty

public static long getLongProperty(java.lang.String module,
                   java.lang.String property,
                   int defaultValue)

Get a configuration property as an long, with default

Parameters:

module - the module, or null for regular property

property - the name of the property

defaultValue - value to return if property is not found or is not a Long.

Returns:

the value of the property. default is returned if the property does not exist or is not an Integer. To differentiate between this case and when the property actually is false, use getProperty.

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String property)

Get a configuration property as a boolean. True is indicated if the value of the property is TRUE or YES (case insensitive.)

Parameters:

property - the name of the property

Returns:

the value of the property. false is returned if the property does not exist. To differentiate between this case and when the property actually is false, use getProperty.

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String module,
                         java.lang.String property)

Get a module configuration property as a boolean. True is indicated if the value of the property is TRUE or YES (case insensitive.)

Parameters:

module - the module, or null for regular property

property - the name of the property

Returns:

the value of the property. false is returned if the property does not exist. To differentiate between this case and when the property actually is false, use getProperty.

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String property,
                         boolean defaultValue)

Get a configuration property as a boolean, with default. True is indicated if the value of the property is TRUE or YES (case insensitive.)

Parameters:

property - the name of the property

defaultValue - value to return if property is not found.

Returns:

the value of the property. default is returned if the property does not exist. To differentiate between this case and when the property actually is false, use getProperty.

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String module,
                         java.lang.String property,
                         boolean defaultValue)

Get a module configuration property as a boolean, with default. True is indicated if the value of the property is TRUE or YES (case insensitive.)

Parameters:

module - module, or null for regular property

property - the name of the property

defaultValue - value to return if property is not found.

Returns:

the value of the property. default is returned if the property does not exist. To differentiate between this case and when the property actually is false, use getProperty.

propertyNames

public static java.util.Enumeration<?> propertyNames()

Returns an enumeration of all the keys in the DSpace configuration

Returns:

an enumeration of all the keys in the DSpace configuration

propertyNames

public static java.util.Enumeration<?> propertyNames(java.lang.String module)

Returns an enumeration of all the keys in a module configuration

Parameters:

module - module, or null for regular property

Returns:

an enumeration of all the keys in the module configuration, or null if the module does not exist.

getConfigurationFile

protected static java.io.File getConfigurationFile()

Deprecated. Please remove all direct usage of the configuration file.

Return the file that configuration was actually loaded from.

Returns:

File naming configuration data file.

loadConfig

public static void loadConfig(java.lang.String configFile)

Load the DSpace configuration properties. Only does anything if properties are not already loaded. Properties are loaded in from the specified file, or default locations.

Parameters:

configFile - The dspace.cfg configuration file to use, or null to try default locations

getNewsFilePath

public static java.lang.String getNewsFilePath()

Deprecated. since 4.0

Wrapper for NewsManager.getNewsFilePath().

readNewsFile

public static java.lang.String readNewsFile(java.lang.String name)

Deprecated. since 4.0

Wrapper for NewsManager.readNewsFile(java.lang.String).

writeNewsFile

public static java.lang.String writeNewsFile(java.lang.String file,
                             java.lang.String news)

Deprecated. since 4.0

Wrapper for NewsManager.writeNewsFile(java.lang.String, java.lang.String).

getLicenseText

public static java.lang.String getLicenseText(java.lang.String licenseFile)

Deprecated. since 4.0

Wrapper for LicenseManager.getLicenseText(java.lang.String).

getDefaultSubmissionLicense

public static java.lang.String getDefaultSubmissionLicense()

Deprecated. since 4.0

Wrapper for LicenseManager.getDefaultSubmissionLicense().

writeLicenseFile

public static void writeLicenseFile(java.lang.String licenseFile,
                    java.lang.String newLicense)

Deprecated. since 4.0

Wrapper for LicenseManager.writeLicenseFile(java.lang.String, java.lang.String).

main

public static void main(java.lang.String[] argv)

Command-line interface for running configuration tasks. Possible arguments:

• -property name prints the value of the property name from dspace.cfg to the standard output. If the property does not exist, nothing is written.

Parameters:

argv - command-line arguments