GlobalSettings (Berlioz 0.10.3-SNAPSHOT API)

java.lang.Object
- org.pageseeder.berlioz.GlobalSettings

```
public final class GlobalSettings
extends Object
```
Berlioz global settings.
This class provides a global access to the settings for the application. It needs to be setup prior to using most of the classes used in this application.
This class uses two main access points:
- repository: is the root directory that contains all of the configuration files for the application.
- configuration: is the file that contains all the global properties used in this application; it is always located in the /config directory of the repository; the default name of this file 'config.xml'.
The repository and config may be specified using System properties, respectively berlioz.repository and berlioz.config.
Since:

Berlioz 0.6

Version:

Berlioz 0.9.31 - 8 January 2015

Author:

Christophe Lauret

See Also:

load(), setRepository(File), setMode(String)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_DIRECTORY` Name of the configuration directory in the repository.
`static String`	`DEFAULT_MODE` Name of the default configuration to use.
`static String`	`LIBRARY_DIRECTORY` Name of the directory in the repository that contains all the schemas / DTD for the XML files used by Berlioz.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static int`	`countProperties()` Returns the number of properties defined in the file.
`static String`	`get(BerliozOption option)` Return the property value for the specified Berlioz option.
`static String`	`get(String name)` Return the requested property.
`static boolean`	`get(String name, boolean def)` Returns the requested property or it default value.
`static File`	`get(String name, File def)` Returns the requested property as a file or its default file value.
`static int`	`get(String name, int def)`
`static String`	`get(String name, String def)` Returns the requested property or it default value.
`static File`	`getDirProperty(String name)` Returns the requested property as a file.
`static File`	`getFileProperty(String name)` Returns the requested property as a file.
`static File`	`getLibrary()` Returns the directory containing the DTDs and schemas for the XML in use in the system.
`static String`	`getMode()` Returns the configuration to use.
`static Properties`	`getNode(String name)` Returns the entries for the specified node as `Properties`.
`static File`	`getPropertiesFile()` Returns the properties file to use externally.
`static File`	`getRepository()` Returns the main repository or `null` if it has not been setup.
`static String`	`getVersion()` Returns the build version of Berlioz.
`static boolean`	`has(BerliozOption option)` Indicates whether the property value for the specified Berlioz option is enabled.
`static boolean`	`load()` Loads the properties.
`static Enumeration<String>`	`propertyNames()` Enumerates the properties in the global settings.
`static void`	`registerListener(ConfigListener listener)` Add a listener to invoke when the settings are being loaded or reloaded.
`static void`	`setConfig(String name)` Deprecated. Use `setMode(String)` instead.
`static void`	`setMode(String name)` Sets the configuration mode to use.
`static void`	`setRepository(File dir)` Sets the repository to the specified file if it exists and is a directory.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONFIG_DIRECTORY
```
public static final String CONFIG_DIRECTORY
```
    Name of the configuration directory in the repository.
    
    See Also:
    
    Constant Field Values
  - LIBRARY_DIRECTORY
```
public static final String LIBRARY_DIRECTORY
```
    Name of the directory in the repository that contains all the schemas / DTD for the XML files used by Berlioz.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MODE
```
public static final String DEFAULT_MODE
```
    Name of the default configuration to use.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getRepository
```
public static File getRepository()
```
    Returns the main repository or null if it has not been setup.
    
    Returns:
    
    The directory used as a repository or null.
  - countProperties
```
public static int countProperties()
```
    Returns the number of properties defined in the file.
    
    Returns:
    
    The number of properties defined in the file.
  - getVersion
```
public static String getVersion()
```
    Returns the build version of Berlioz.
    
    Returns:
    
    the Berlioz version.
  - getMode
```
public static String getMode()
```
    Returns the configuration to use.
    
    Returns:
    
    The name of the configuration to use.
  - getLibrary
```
public static File getLibrary()
```
    Returns the directory containing the DTDs and schemas for the XML in use in the system.
    This method will return a file only if the repository has been properly set, and will be the directory defined by LIBRARY_DIRECTORY in the repository.
    
    Returns:
    
    The directory containing the DTDs and schemas for the XML.
  - getPropertiesFile
```
public static File getPropertiesFile()
```
    Returns the properties file to use externally.
    
    Returns:
    
    The properties file to load or null.
  - get
```
public static String get(String name)
                  throws IllegalStateException
```
    Return the requested property.
    Returns null if the property is not found or defined.
    If the properties file has not been loaded, this method will invoke the load() method before returning an Enumeration.
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the property value or null.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - get
```
public static String get(BerliozOption option)
                  throws IllegalStateException
```
    Return the property value for the specified Berlioz option.
    Returns the default value if the property is not found or defined.
    If the properties file has not been loaded, this method will invoke the load() method before returning an Enumeration.
    
    Parameters:
    
    option - the name of the property
    
    Returns:
    
    the property value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - has
```
public static boolean has(BerliozOption option)
```
    Indicates whether the property value for the specified Berlioz option is enabled.
    Returns the default value if the property is not found or defined.
    If the properties file has not been loaded, this method will invoke the load() method.
    
    Parameters:
    
    option - the name of the property
    
    Returns:
    
    whether the specified option is set to true or not.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
    
    IllegalArgumentException - If this class has not been setup properly.
    
    NullPointerException - If the specified option is null.
  - get
```
public static String get(String name,
                         String def)
                  throws IllegalStateException
```
    Returns the requested property or it default value.
    The given default value is returned only if the property is not found.
    If the properties file has not been loaded, this method will invoke the load() method before returning an Enumeration.
    
    Parameters:
    
    name - The name of the property.
    
    def - A default value for the property.
    
    Returns:
    
    the property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - get
```
public static int get(String name,
                      int def)
               throws IllegalStateException
```
    Parameters:
    
    name - The name of the property.
    
    def - A default value for the property.
    
    Returns:
    
    the property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - get
```
public static boolean get(String name,
                          boolean def)
                   throws IllegalStateException
```
    Returns the requested property or it default value.
    The given default value is returned only if the property is not found.
    If the properties file has not been loaded, this method will invoke the load().
    
    Parameters:
    
    name - The name of the property.
    
    def - A default value for the property.
    
    Returns:
    
    the property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - get
```
public static File get(String name,
                       File def)
                throws IllegalStateException
```
    Returns the requested property as a file or its default file value.
    The given default value is returned if:
    - the property is not found;
    - the file corresponding to the property does not exist;
    - there is an error.
    If the properties file has not been loaded, this method will invoke the load().
    Parameters:
    
    name - The name of the property.
    
    def - A default value for the property.
    
    Returns:
    
    the property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - getDirProperty
```
public static File getDirProperty(String name)
                           throws IllegalStateException
```
    Returns the requested property as a file.
    The given default value is returned if:
    - the property is not found;
    - the file corresponding to the property does not exist;
    - there is an error
    If the properties file has not been loaded, this method will invoke the load().
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    the property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - getFileProperty
```
public static File getFileProperty(String name)
                            throws IllegalStateException
```
    Returns the requested property as a file.
    The given default value is returned if:
    - the property is not found;
    - the file corresponding to the property does not exist;
    - there is an error
    If the properties file has not been loaded, this method will invoke the load().
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    the property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - getNode
```
public static Properties getNode(String name)
```
    Returns the entries for the specified node as Properties.
    
    Parameters:
    
    name - The name of the database.
    
    Returns:
    
    The property value or the default value.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - propertyNames
```
public static Enumeration<String> propertyNames()
                                         throws IllegalStateException
```
    Enumerates the properties in the global settings.
    
    Returns:
    
    An enumeration of the property names.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
  - setRepository
```
public static void setRepository(File dir)
                          throws IllegalArgumentException
```
    Sets the repository to the specified file if it exists and is a directory.
    Does nothing if the specified file is null.
    If the specified file does not exist or is not a directory, the repository will remain unchanged.
    
    Parameters:
    
    dir - The directory to use as the main repository.
    
    Throws:
    
    IllegalArgumentException - If the specified file is not a valid repository.
  - setMode
```
public static void setMode(String name)
```
    Sets the configuration mode to use.
    
    Parameters:
    
    name - The name of the mode to use.
    
    Throws:
    
    NullPointerException - If the name of the mode is null.
  - setConfig
```
@Deprecated
public static void setConfig(String name)
                                   throws IllegalArgumentException
```
    Deprecated. Use setMode(String) instead.
    
    Sets the configuration to use.
    
    Parameters:
    
    name - The name of the configuration to use.
    
    Throws:
    
    IllegalArgumentException - If the name of the configuration is null.
  - load
```
public static boolean load()
                    throws IllegalStateException
```
    Loads the properties.
    There are several mechanism to load the properties.
    First, this method will try to use the properties file that might have been setup with the #setPropertiesFile(File) method.
    If all of the above fail, the properties will remain empty, this method will return false to indicate that the properties could not be loaded.
    Errors will only be reported to the System error output, the complete stack trace will be available.
    In all cases, the file must be conform to the java properties specifications.
    
    Returns:
    
    true if the properties were loaded; false otherwise.
    
    Throws:
    
    IllegalStateException - If this class has not been setup properly.
    
    See Also:
    
    Properties, System.getProperty(java.lang.String), ClassLoader.getResourceAsStream(java.lang.String)
  - registerListener
```
public static void registerListener(ConfigListener listener)
```
    Add a listener to invoke when the settings are being loaded or reloaded.
    
    Parameters:
    
    listener - The listener to register.

Class GlobalSettings

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_DIRECTORY

LIBRARY_DIRECTORY

DEFAULT_MODE

Method Detail

getRepository

countProperties

getVersion

getMode

getLibrary

getPropertiesFile

get

get

has

get

get

get

get

getDirProperty

getFileProperty

getNode

propertyNames

setRepository

setMode

setConfig

load

registerListener