Apache Log4cxx  Version 1.6.0
Loading...
Searching...
No Matches
log4cxx::spi::Configurator Class Referenceabstract

An abstract base for classes capable of configuring Log4cxx. More...

#include <configurator.h>

Inheritance diagram for log4cxx::spi::Configurator:
log4cxx::helpers::Object log4cxx::PropertyConfigurator log4cxx::xml::DOMConfigurator

Public Member Functions

virtual ConfigurationStatus doConfigure (const File &configFileName, spi::LoggerRepositoryPtr repository)=0
 Read configuration from configFileName.
Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
virtual const helpers::ClassgetClass () const =0
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

Static Public Member Functions

static helpers::Propertiesproperties ()
 The key value pairs used when expanding ${varname} instances in a configuration file.

Protected Member Functions

 Configurator ()

Detailed Description

An abstract base for classes capable of configuring Log4cxx.

Constructor & Destructor Documentation

◆ Configurator()

log4cxx::spi::Configurator::Configurator ( )
protected

Member Function Documentation

◆ doConfigure()

virtual ConfigurationStatus log4cxx::spi::Configurator::doConfigure ( const File & configFileName,
spi::LoggerRepositoryPtr repository )
pure virtual

Read configuration from configFileName.

If repository is not provided, the spi::LoggerRepository held by LogManager is used.

Parameters
configFileNameThe file to parse
repositoryHolds the Logger instances.

Implemented in log4cxx::PropertyConfigurator, and log4cxx::xml::DOMConfigurator.

◆ properties()

helpers::Properties & log4cxx::spi::Configurator::properties ( )
static

The key value pairs used when expanding ${varname} instances in a configuration file.

By default, the map holds the currently executing program file path and the std::filesystem::path decomposition of the currently executing program file path, using the variable names:

  • PROGRAM_FILE_PATH
  • PROGRAM_FILE_PATH.ROOT_NAME
  • PROGRAM_FILE_PATH.ROOT_DIRECTORY
  • PROGRAM_FILE_PATH.ROOT_PATH
  • PROGRAM_FILE_PATH.RELATIVE_PATH
  • PROGRAM_FILE_PATH.PARENT_PATH
  • PROGRAM_FILE_PATH.FILENAME
  • PROGRAM_FILE_PATH.STEM
  • PROGRAM_FILE_PATH.EXTENSION
Examples
com/foo/config4.cpp.

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