org.refcodes.logger.utils

Class RuntimeLoggerUtility

java.lang.Object

org.refcodes.logger.utils.RuntimeLoggerUtility

public class RuntimeLoggerUtility
extends Object

Useful methods regarding the RuntimeLogger type.

Constructor Summary

Constructors

Constructor and Description
RuntimeLoggerUtility()

Method Summary

Modifier and Type	Method and Description
static RuntimeLogger	fromConfigurationFile(String aElementPath, String aConfigFileName) Instantiates a RuntimeLogger from the referenced configuration file (usually "runtimelogger-config.xml") which's declaration is identified in the configuration XML structure at the given element path.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeLoggerUtility

public RuntimeLoggerUtility()

Method Detail

fromConfigurationFile

public static RuntimeLogger fromConfigurationFile(String aElementPath,
                                                  String aConfigFileName)
                                           throws LoggerInstantiationRuntimeException

Instantiates a RuntimeLogger from the referenced configuration file (usually "runtimelogger-config.xml") which's declaration is identified in the configuration XML structure at the given element path. The applications base directory (where your JAR or your classes reside) is taken and a list of directories relative to this base directory is generated as defined in the RuntimeConsts.CONFIG_DIR_NAMES: The actual directories being looked at for the config file (in case them exist) are as follows, relative to your applications base directory:

• ../config"
• ../etc"
• ../settings"
• ../.config"
• ../settings"
• ."
• ./config"
• ./etc"
• ./settings"
• ./.config"
• ./settings"
In case you pass a JVM argument via "-Dconfig.dir=path_to_your_config_dir" (where path_to_your_config_dir stands for the path to the directory where you placed configuration files such as the "runtimelogger-config.xml" file), then your path_to_your_config_dir is placed first in the list of configuration directories to look at (in case the directory exists).See RuntimeConsts.SYS_PROP_CONFIG_DIR

Parameters:

aElementPath - The element path in the XML file identifying the logger's configuration.

aConfigFileName - The file to load the RuntimeLogger configuration from.

Returns:

The RuntimeLogger instance being created.

Throws:

LoggerInstantiationRuntimeException - Thrown in case instantiating a Logger (RuntimeLogger) failed.