Apache log4cxx  Version 0.12.0
log4cxx::xml::DOMConfigurator Class Reference

Use this class to initialize the log4cxx environment using a DOM tree. More...

#include <domconfigurator.h>

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

Public Member Functions

 DOMConfigurator ()
 
 DOMConfigurator (log4cxx::helpers::Pool &p)
 
void doConfigure (const File &filename, spi::LoggerRepositoryPtr repository)
 Interpret the XML file pointed by filename and set up log4cxx accordingly. More...
 
- Public Member Functions inherited from log4cxx::spi::Configurator
 Configurator ()
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Static Public Member Functions

static void configure (const std::string &filename)
 A static version of doConfigure. More...
 
static void configure (const std::wstring &filename)
 
static void configure (const std::basic_string< UniChar > &filename)
 
static void configure (const CFStringRef &filename)
 
static void configureAndWatch (const std::string &configFilename)
 Like configureAndWatch(const std::string& configFilename, long delay) except that the default delay as defined by log4cxx::helpers::FileWatchdog::DEFAULT_DELAY is used. More...
 
static void configureAndWatch (const std::wstring &configFilename)
 
static void configureAndWatch (const std::basic_string< UniChar > &configFilename)
 
static void configureAndWatch (const CFStringRef &configFilename)
 
static void configureAndWatch (const std::string &configFilename, long delay)
 Read the configuration file configFilename if it exists. More...
 
static void configureAndWatch (const std::wstring &configFilename, long delay)
 
static void configureAndWatch (const std::basic_string< UniChar > &configFilename, long delay)
 
static void configureAndWatch (const CFStringRef &configFilename, long delay)
 

Protected Types

typedef std::map< LogString, AppenderPtrAppenderMap
 

Protected Member Functions

AppenderPtr findAppenderByName (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *elem, apr_xml_doc *doc, const LogString &appenderName, AppenderMap &appenders)
 Used internally to parse appenders by IDREF name. More...
 
AppenderPtr findAppenderByReference (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *appenderRef, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to parse appenders by IDREF element. More...
 
AppenderPtr parseAppender (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *appenderElement, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to parse an appender element. More...
 
void parseErrorHandler (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, AppenderPtr &appender, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to parse an ErrorHandler element. More...
 
void parseFilters (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, std::vector< log4cxx::spi::FilterPtr > &filters)
 Used internally to parse a filter element. More...
 
void parseLogger (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *loggerElement, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to parse a logger element. More...
 
void parseLoggerFactory (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *factoryElement)
 Used internally to parse the logger factory element. More...
 
log4cxx::helpers::ObjectPtr parseTriggeringPolicy (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *factoryElement)
 Used internally to parse the logger factory element. More...
 
log4cxx::rolling::RollingPolicyPtr parseRollingPolicy (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *factoryElement)
 Used internally to parse the logger factory element. More...
 
void parseRoot (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *rootElement, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to parse the root logger element. More...
 
void parseChildrenOfLoggerElement (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *catElement, LoggerPtr logger, bool isRoot, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to parse the children of a logger element. More...
 
LayoutPtr parseLayout (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *layout_element)
 Used internally to parse a layout element. More...
 
void parseLevel (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, LoggerPtr logger, bool isRoot)
 Used internally to parse a level element. More...
 
void setParameter (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *elem, log4cxx::config::PropertySetter &propSetter)
 
void parse (log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, apr_xml_doc *doc, AppenderMap &appenders)
 Used internally to configure the log4cxx framework from an in-memory representation of an XML document. More...
 
LogString subst (const LogString &value)
 

Static Protected Member Functions

static LogString getAttribute (log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *, const std::string &attrName)
 

Protected Attributes

helpers::Properties props
 
spi::LoggerRepositoryPtr repository
 
spi::LoggerFactoryPtr loggerFactory
 

Detailed Description

Use this class to initialize the log4cxx environment using a DOM tree.

Sometimes it is useful to see how log4cxx is reading configuration files. You can enable log4cxx internal logging by setting the debug attribute in the log4cxx element. As in

        <log4j:configuration debug="true" xmlns:log4j="http://jakarta.apache.org/log4j/">
        ...
        </log4j:configuration>

There are sample XML files included in the package.

Member Typedef Documentation

◆ AppenderMap

Constructor & Destructor Documentation

◆ DOMConfigurator() [1/2]

log4cxx::xml::DOMConfigurator::DOMConfigurator ( )

◆ DOMConfigurator() [2/2]

log4cxx::xml::DOMConfigurator::DOMConfigurator ( log4cxx::helpers::Pool p)

Member Function Documentation

◆ configure() [1/4]

static void log4cxx::xml::DOMConfigurator::configure ( const std::string &  filename)
static

A static version of doConfigure.

◆ configure() [2/4]

static void log4cxx::xml::DOMConfigurator::configure ( const std::wstring &  filename)
static

◆ configure() [3/4]

static void log4cxx::xml::DOMConfigurator::configure ( const std::basic_string< UniChar > &  filename)
static

◆ configure() [4/4]

static void log4cxx::xml::DOMConfigurator::configure ( const CFStringRef filename)
static

◆ configureAndWatch() [1/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const std::string &  configFilename)
static

Like configureAndWatch(const std::string& configFilename, long delay) except that the default delay as defined by log4cxx::helpers::FileWatchdog::DEFAULT_DELAY is used.

Parameters
configFilenameA log4j configuration file in XML format.

◆ configureAndWatch() [2/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const std::wstring &  configFilename)
static

◆ configureAndWatch() [3/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const std::basic_string< UniChar > &  configFilename)
static

◆ configureAndWatch() [4/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const CFStringRef configFilename)
static

◆ configureAndWatch() [5/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const std::string &  configFilename,
long  delay 
)
static

Read the configuration file configFilename if it exists.

Moreover, a thread will be created that will periodically check if configFilename has been created or modified. The period is determined by the delay argument. If a change or file creation is detected, then configFilename is read to configure log4cxx.

Parameters
configFilenameA log4j configuration file in XML format.
delayThe delay in milliseconds to wait between each check.

◆ configureAndWatch() [6/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const std::wstring &  configFilename,
long  delay 
)
static

◆ configureAndWatch() [7/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const std::basic_string< UniChar > &  configFilename,
long  delay 
)
static

◆ configureAndWatch() [8/8]

static void log4cxx::xml::DOMConfigurator::configureAndWatch ( const CFStringRef configFilename,
long  delay 
)
static

◆ doConfigure()

void log4cxx::xml::DOMConfigurator::doConfigure ( const File filename,
spi::LoggerRepositoryPtr  repository 
)
virtual

Interpret the XML file pointed by filename and set up log4cxx accordingly.

The configuration is done relative to the hierarchy parameter.

Parameters
filenameThe file to parse.
repositoryThe hierarchy to operation upon.

Implements log4cxx::spi::Configurator.

◆ findAppenderByName()

AppenderPtr log4cxx::xml::DOMConfigurator::findAppenderByName ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  elem,
apr_xml_doc *  doc,
const LogString appenderName,
AppenderMap appenders 
)
protected

Used internally to parse appenders by IDREF name.

◆ findAppenderByReference()

AppenderPtr log4cxx::xml::DOMConfigurator::findAppenderByReference ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  appenderRef,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to parse appenders by IDREF element.

◆ getAttribute()

static LogString log4cxx::xml::DOMConfigurator::getAttribute ( log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  ,
const std::string &  attrName 
)
staticprotected

◆ parse()

void log4cxx::xml::DOMConfigurator::parse ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  element,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to configure the log4cxx framework from an in-memory representation of an XML document.

◆ parseAppender()

AppenderPtr log4cxx::xml::DOMConfigurator::parseAppender ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  appenderElement,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to parse an appender element.

◆ parseChildrenOfLoggerElement()

void log4cxx::xml::DOMConfigurator::parseChildrenOfLoggerElement ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  catElement,
LoggerPtr  logger,
bool  isRoot,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to parse the children of a logger element.

◆ parseErrorHandler()

void log4cxx::xml::DOMConfigurator::parseErrorHandler ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  element,
AppenderPtr appender,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to parse an ErrorHandler element.

◆ parseFilters()

void log4cxx::xml::DOMConfigurator::parseFilters ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  element,
std::vector< log4cxx::spi::FilterPtr > &  filters 
)
protected

Used internally to parse a filter element.

◆ parseLayout()

LayoutPtr log4cxx::xml::DOMConfigurator::parseLayout ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  layout_element 
)
protected

Used internally to parse a layout element.

◆ parseLevel()

void log4cxx::xml::DOMConfigurator::parseLevel ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  element,
LoggerPtr  logger,
bool  isRoot 
)
protected

Used internally to parse a level element.

◆ parseLogger()

void log4cxx::xml::DOMConfigurator::parseLogger ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  loggerElement,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to parse a logger element.

◆ parseLoggerFactory()

void log4cxx::xml::DOMConfigurator::parseLoggerFactory ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  factoryElement 
)
protected

Used internally to parse the logger factory element.

◆ parseRollingPolicy()

log4cxx::rolling::RollingPolicyPtr log4cxx::xml::DOMConfigurator::parseRollingPolicy ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  factoryElement 
)
protected

Used internally to parse the logger factory element.

◆ parseRoot()

void log4cxx::xml::DOMConfigurator::parseRoot ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  rootElement,
apr_xml_doc *  doc,
AppenderMap appenders 
)
protected

Used internally to parse the root logger element.

◆ parseTriggeringPolicy()

log4cxx::helpers::ObjectPtr log4cxx::xml::DOMConfigurator::parseTriggeringPolicy ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  factoryElement 
)
protected

Used internally to parse the logger factory element.

◆ setParameter()

void log4cxx::xml::DOMConfigurator::setParameter ( log4cxx::helpers::Pool p,
log4cxx::helpers::CharsetDecoderPtr &  utf8Decoder,
apr_xml_elem *  elem,
log4cxx::config::PropertySetter propSetter 
)
protected

◆ subst()

LogString log4cxx::xml::DOMConfigurator::subst ( const LogString value)
protected

Member Data Documentation

◆ loggerFactory

spi::LoggerFactoryPtr log4cxx::xml::DOMConfigurator::loggerFactory
protected

◆ props

helpers::Properties log4cxx::xml::DOMConfigurator::props
protected

◆ repository

spi::LoggerRepositoryPtr log4cxx::xml::DOMConfigurator::repository
protected

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