Apache Log4cxx: log4cxx::DefaultConfigurator Class Reference (original) (raw)

Configures the repository from environmental settings and files. More...

#include <[defaultconfigurator.h](defaultconfigurator%5F8h%5Fsource.html)>

Configures the repository from environmental settings and files.

◆ configure()

Configure repository.

If the configuration file name has not been provided by a call to setConfigurationFileName(), the environment variables "LOG4CXX_CONFIGURATION" and "log4j.configuration" are examined. Unless a custom configurator is specified using the "LOG4CXX_CONFIGURATOR_CLASS" or "log4j.configuratorClass" environment variable, the PropertyConfigurator will be used to configure log4cxx unless the file name ends with the ".xml" extension, in which case the DOMConfigurator will be used. If a custom configurator is specified, the environment variable should contain a fully qualified class name of a class that implements the Configurator interface.

If the configuration file name is not found using any of the previous approaches, the current directory is examined for a file with extension ".xml" or ".properties" with a base name "log4cxx" or "log4j".

If a positive number has been provided by a call to setConfigurationWatchSeconds() or the environment variables "LOG4CXX_CONFIGURATION_WATCH_SECONDS" contains a positive number a background thread is started that will periodically check for a change to the configuration file and apply any configuration changes found.

◆ configureFromFile()

Configure Log4cxx from a file.

This method will attempt to load the configuration files in the directories given.

For example, if we want a configuration file named 'myapp-logging.xml' with the default location for this file in /etc/myapp, but to have this overriden by a file in /usr/local/etc/myapp, we would call this function as follows:

configureFromFile( { "/usr/local/etc/myapp", "/etc/myapp" }, { "myapp-logging.xml" );

This will then search for files in the following order:

/usr/local/etc/myapp/myapp-logging.xml /etc/myapp/myapp-logging.xml

The status of configuring Log4cxx as well as the eventual filename used is returned. If a file exists but it is not able to be used to configure Log4cxx, the next file in the list will be tried until a valid configuration file is found or the end of the list is reached.

Parameters

Returns

The status of the configuration, and the filename loaded(if a file was found).

◆ setConfigurationFileName()

Make path the configuration file used by configure().

◆ setConfigurationWatchSeconds()

Make seconds the time a background thread will delay before checking for a change to the configuration file used by configure().

The documentation for this class was generated from the following file:

• defaultconfigurator.h