org.apache.log4j.xml
public class DOMConfigurator extends Object implements Configurator
The DTD is specified in log4j.dtd.
Sometimes it is useful to see how log4j is reading configuration
files. You can enable log4j internal logging by defining the
log4j.debug variable on the java command
line. Alternatively, set the debug
attribute in the
log4j:configuration
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.
Since: 0.8.3
Constructor Summary | |
---|---|
DOMConfigurator()
No argument constructor. |
Method Summary | |
---|---|
static void | configure(Element element)
Configure log4j using a configuration element as
defined in the log4j.dtd. |
static void | configure(String filename)
A static version of DOMConfigurator. |
static void | configure(URL url)
A static version of DOMConfigurator. |
static void | configureAndWatch(String configFilename)
Like DOMConfigurator except that the
default delay as defined by DEFAULT_DELAY is
used. |
static void | configureAndWatch(String configFilename, long delay)
Read the configuration file configFilename if it
exists. |
void | doConfigure(String filename, LoggerRepository repository) |
void | doConfigure(URL url, LoggerRepository repository) |
void | doConfigure(InputStream inputStream, LoggerRepository repository)
Configure log4j by reading in a log4j.dtd compliant XML
configuration file. |
void | doConfigure(Reader reader, LoggerRepository repository)
Configure log4j by reading in a log4j.dtd compliant XML
configuration file. |
protected void | doConfigure(InputSource inputSource, LoggerRepository repository)
Configure log4j by reading in a log4j.dtd compliant XML
configuration file. |
void | doConfigure(Element element, LoggerRepository repository)
Configure by taking in an DOM element. |
protected Appender | findAppenderByName(Document doc, String appenderName)
Used internally to parse appenders by IDREF name. |
protected Appender | findAppenderByReference(Element appenderRef)
Used internally to parse appenders by IDREF element. |
protected void | parse(Element element)
Used internally to configure the log4j framework by parsing a DOM
tree of XML elements based on log4j.dtd. |
protected Appender | parseAppender(Element appenderElement)
Used internally to parse an appender element. |
protected void | parseCategory(Element loggerElement)
Used internally to parse an category element. |
protected void | parseCategoryFactory(Element factoryElement)
Used internally to parse the category factory element. |
protected void | parseChildrenOfLoggerElement(Element catElement, Logger cat, boolean isRoot)
Used internally to parse the children of a category element. |
protected void | parseErrorHandler(Element element, Appender appender)
Used internally to parse an ErrorHandler element. |
protected void | parseFilters(Element element, Appender appender)
Used internally to parse a filter element. |
protected Layout | parseLayout(Element layout_element)
Used internally to parse a layout element. |
protected void | parseLevel(Element element, Logger logger, boolean isRoot)
Used internally to parse a level element. |
protected void | parseRenderer(Element element) |
protected void | parseRoot(Element rootElement)
Used internally to parse the roor category element. |
protected void | setParameter(Element elem, PropertySetter propSetter) |
protected String | subst(String value) |
configuration
element as
defined in the log4j.dtd.Parameters: configFilename A log4j configuration file in XML format.
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 log4j.Parameters: configFilename A log4j configuration file in XML format. delay The delay in milliseconds to wait between each check.