de.hawhamburg.reachability.conf

Class LoggerConfig

java.lang.Object

de.hawhamburg.reachability.conf.LoggerConfig

public final class LoggerConfig
extends java.lang.Object

Logger related configuration management.

This class provides the configuration management related to the file logger. It manages the XML configuration file source and provides method for fetching these values in different formats.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private static SimpleXMLConfigFile	configFileXML The configuration file as SimpleXMLConfigFile object.
private static java.lang.String	LOGGER_CONFIG_PATH_KEY The property key which holds the path to to logger configuration file.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LoggerConfig() No instances of this utility class.

Method Summary

Methods

Modifier and Type	Method and Description
private static void	checkLoad() Ensures that the configuration file was at least tried to load once.
static java.lang.Boolean	exists() Determines if the XML configuration file exists.
static java.lang.String	get(java.lang.String config) Tries to fetch the value of the requested configuration variable from the XML source as String.
static <T> T	get(java.lang.String config, java.lang.Class<T> clazz) Tries to fetch the value of the requested configuration variable from the XML source as object of clazz.
static void	refresh() Refreshes the local representation of the XML configuration file.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER_CONFIG_PATH_KEY

private static final java.lang.String LOGGER_CONFIG_PATH_KEY

The property key which holds the path to to logger configuration file.

See Also:

Constant Field Values

configFileXML

private static SimpleXMLConfigFile configFileXML

The configuration file as SimpleXMLConfigFile object.

Constructor Detail

LoggerConfig

private LoggerConfig()

No instances of this utility class.

Method Detail

get

public static java.lang.String get(java.lang.String config)

Tries to fetch the value of the requested configuration variable from the XML source as String.

Parameters:

config - The name of the requested configuration variable as String.

Returns:

The value of the configuration variable if found, otherwise null.

get

public static <T> T get(java.lang.String config,
        java.lang.Class<T> clazz)

Tries to fetch the value of the requested configuration variable from the XML source as object of clazz.

Type Parameters:

T - The result type is defined by clazz.

Parameters:

config - The name of the requested configuration variable as String.

clazz - The object type as which the value shall be returned.

Returns:

The value of the configuration variable as object of clazz, otherwise null.

checkLoad

private static void checkLoad()

Ensures that the configuration file was at least tried to load once. Caches the file as instance variable at first successful method call.

refresh

public static void refresh()

Refreshes the local representation of the XML configuration file.

exists

public static java.lang.Boolean exists()

Determines if the XML configuration file exists.

Returns:

true if the XML configuration file exists, otherwise false.