DOMConfigurator Class Reference

Inheritance diagram for DOMConfigurator:

Inheritance graph
[legend]
Collaboration diagram for DOMConfigurator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void doConfigure (const String &filename, spi::LoggerRepositoryPtr &repository)

Static Public Member Functions

static void configure (const String &filename)
static void configureAndWatch (const String &configFilename)
static void configureAndWatch (const String &configFilename, long delay)

Protected Member Functions

AppenderPtr findAppenderByName (helpers::XMLDOMDocumentPtr doc, const String &appenderName)
AppenderPtr findAppenderByReference (helpers::XMLDOMElementPtr appenderRef)
AppenderPtr parseAppender (helpers::XMLDOMElementPtr appenderElement)
void parseErrorHandler (helpers::XMLDOMElementPtr element, AppenderPtr appender)
void parseFilters (helpers::XMLDOMElementPtr element, AppenderPtr appender)
void parseLogger (helpers::XMLDOMElementPtr loggerElement)
void parseLoggerFactory (helpers::XMLDOMElementPtr factoryElement)
void parseRoot (helpers::XMLDOMElementPtr rootElement)
void parseChildrenOfLoggerElement (helpers::XMLDOMElementPtr catElement, LoggerPtr logger, bool isRoot)
LayoutPtr parseLayout (helpers::XMLDOMElementPtr layout_element)
void parseLevel (helpers::XMLDOMElementPtr element, LoggerPtr logger, bool isRoot)
void parse (helpers::XMLDOMElementPtr element)

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 Function Documentation

AppenderPtr findAppenderByName ( helpers::XMLDOMDocumentPtr  doc,
const String &  appenderName 
) [protected]

Used internally to parse appenders by IDREF name.

AppenderPtr findAppenderByReference ( helpers::XMLDOMElementPtr  appenderRef  )  [protected]

Used internally to parse appenders by IDREF element.

AppenderPtr parseAppender ( helpers::XMLDOMElementPtr  appenderElement  )  [protected]

Used internally to parse an appender element.

void parseErrorHandler ( helpers::XMLDOMElementPtr  element,
AppenderPtr  appender 
) [protected]

Used internally to parse an ErrorHandler element.

void parseFilters ( helpers::XMLDOMElementPtr  element,
AppenderPtr  appender 
) [protected]

Used internally to parse a filter element.

void parseLogger ( helpers::XMLDOMElementPtr  loggerElement  )  [protected]

Used internally to parse a logger element.

void parseLoggerFactory ( helpers::XMLDOMElementPtr  factoryElement  )  [protected]

Used internally to parse the logger factory element.

void parseRoot ( helpers::XMLDOMElementPtr  rootElement  )  [protected]

Used internally to parse the roor category element.

void parseChildrenOfLoggerElement ( helpers::XMLDOMElementPtr  catElement,
LoggerPtr  logger,
bool  isRoot 
) [protected]

Used internally to parse the children of a category element.

LayoutPtr parseLayout ( helpers::XMLDOMElementPtr  layout_element  )  [protected]

Used internally to parse a layout element.

void parseLevel ( helpers::XMLDOMElementPtr  element,
LoggerPtr  logger,
bool  isRoot 
) [protected]

Used internally to parse a level element.

void parse ( helpers::XMLDOMElementPtr  element  )  [protected]

Used internally to configure the log4cxx framework by parsing a DOM tree of XML elements based on log4j.dtd.

void configure ( const String &  filename  )  [static]

A static version of doConfigure.

void configureAndWatch ( const String &  configFilename  )  [static]

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

Parameters:
configFilename A log4j configuration file in XML format.

void configureAndWatch ( const 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:
configFilename A log4j configuration file in XML format.
delay The delay in milliseconds to wait between each check.

void doConfigure ( const String &  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:
filename The file to parse.
repository The hierarchy to operation upon.

Implements Configurator.


The documentation for this class was generated from the following files:
Generated on Thu Mar 29 15:44:54 2007 for log4cxx by  doxygen 1.5.1