Package org.apache.log4j.extras

Class DOMConfigurator

  • All Implemented Interfaces:
    org.apache.log4j.spi.Configurator
    public class DOMConfigurator
extends java.lang.Object
implements org.apache.log4j.spi.Configurator
    This is a duplicate (with minor modifications) of the log4j 1.2.15 DOMConfigurator renamed for use with earlier versions of log4j.

    • Constructor Summary

      Constructors 
      Constructor Description
      DOMConfigurator()
      No argument constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void configure​(java.lang.String filename)
      A static version of doConfigure(String, LoggerRepository).
      static void configure​(java.net.URL url)
      A static version of doConfigure(URL, LoggerRepository).
      static void configure​(org.w3c.dom.Element element)
      Configure log4j using a configuration element as defined in the log4j.dtd.
      static void configureAndWatch​(java.lang.String configFilename)
      Like configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
      static void configureAndWatch​(java.lang.String configFilename, long delay)
      Read the configuration file configFilename if it exists.
      void doConfigure​(java.io.InputStream inputStream, org.apache.log4j.spi.LoggerRepository repository)
      Configure log4j by reading in a log4j.dtd compliant XML configuration file.
      void doConfigure​(java.io.Reader reader, org.apache.log4j.spi.LoggerRepository repository)
      Configure log4j by reading in a log4j.dtd compliant XML configuration file.
      void doConfigure​(java.lang.String filename, org.apache.log4j.spi.LoggerRepository repository)  
      void doConfigure​(java.net.URL url, org.apache.log4j.spi.LoggerRepository repository)  
      private void doConfigure​(DOMConfigurator.ParseAction action, org.apache.log4j.spi.LoggerRepository repository)  
      void doConfigure​(org.w3c.dom.Element element, org.apache.log4j.spi.LoggerRepository repository)
      Configure by taking in an DOM element.
      protected void doConfigure​(org.xml.sax.InputSource inputSource, org.apache.log4j.spi.LoggerRepository repository)
      Configure log4j by reading in a log4j.dtd compliant XML configuration file.
      protected org.apache.log4j.Appender findAppenderByName​(org.w3c.dom.Document doc, java.lang.String appenderName)
      Used internally to parse appenders by IDREF name.
      protected org.apache.log4j.Appender findAppenderByReference​(org.w3c.dom.Element appenderRef)
      Used internally to parse appenders by IDREF element.
      protected void parse​(org.w3c.dom.Element element)
      Used internally to configure the log4j framework by parsing a DOM tree of XML elements based on log4j.dtd.
      protected org.apache.log4j.Appender parseAppender​(org.w3c.dom.Element appenderElement)
      Used internally to parse an appender element.
      protected void parseCategory​(org.w3c.dom.Element loggerElement)
      Used internally to parse an category element.
      protected void parseCategoryFactory​(org.w3c.dom.Element factoryElement)
      Used internally to parse the category factory element.
      protected void parseChildrenOfLoggerElement​(org.w3c.dom.Element catElement, org.apache.log4j.Logger cat, boolean isRoot)
      Used internally to parse the children of a category element.
      static org.apache.log4j.spi.OptionHandler parseElement​(org.w3c.dom.Element element, java.util.Properties props, java.lang.Class expectedClass)
      Creates an OptionHandler and processes any nested param elements but does not call activateOptions.
      protected void parseErrorHandler​(org.w3c.dom.Element element, org.apache.log4j.Appender appender)
      Used internally to parse an ErrorHandler element.
      protected void parseFilters​(org.w3c.dom.Element element, org.apache.log4j.Appender appender)
      Used internally to parse a filter element.
      protected org.apache.log4j.Layout parseLayout​(org.w3c.dom.Element layout_element)
      Used internally to parse a layout element.
      protected void parseLevel​(org.w3c.dom.Element element, org.apache.log4j.Logger logger, boolean isRoot)
      Used internally to parse a level element.
      protected void parseRenderer​(org.w3c.dom.Element element)  
      protected void parseRoot​(org.w3c.dom.Element rootElement)
      Used internally to parse the roor category element.
      private static void parseUnrecognizedElement​(java.lang.Object instance, org.w3c.dom.Element element, java.util.Properties props)
      Delegates unrecognized content to created instance if it supports UnrecognizedElementParser.
      private static void quietParseUnrecognizedElement​(java.lang.Object instance, org.w3c.dom.Element element, java.util.Properties props)
      Delegates unrecognized content to created instance if it supports UnrecognizedElementParser and catches and logs any exception.
      protected void setParameter​(org.w3c.dom.Element elem, org.apache.log4j.config.PropertySetter propSetter)  
      static void setParameter​(org.w3c.dom.Element elem, org.apache.log4j.config.PropertySetter propSetter, java.util.Properties props)
      Sets a parameter based from configuration file content.
      protected java.lang.String subst​(java.lang.String value)  
      static java.lang.String subst​(java.lang.String value, java.util.Properties props)
      Substitutes property value for any references in expression.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DOMConfigurator

        public DOMConfigurator()
        No argument constructor.

    • Method Detail

      • findAppenderByName

        protected org.apache.log4j.Appender findAppenderByName​(org.w3c.dom.Document doc,
                                                       java.lang.String appenderName)
        Used internally to parse appenders by IDREF name.

      • findAppenderByReference

        protected org.apache.log4j.Appender findAppenderByReference​(org.w3c.dom.Element appenderRef)
        Used internally to parse appenders by IDREF element.

      • parseUnrecognizedElement

        private static void parseUnrecognizedElement​(java.lang.Object instance,
                                             org.w3c.dom.Element element,
                                             java.util.Properties props)
                                      throws java.lang.Exception
        Delegates unrecognized content to created instance if it supports UnrecognizedElementParser.
        Parameters:
        instance - instance, may be null.
        element - element, may not be null.
        props - properties
        Throws:
        java.io.IOException - thrown if configuration of owner object should be abandoned.
        java.lang.Exception
        Since:
        1.2.15

      • quietParseUnrecognizedElement

        private static void quietParseUnrecognizedElement​(java.lang.Object instance,
                                                  org.w3c.dom.Element element,
                                                  java.util.Properties props)
        Delegates unrecognized content to created instance if it supports UnrecognizedElementParser and catches and logs any exception.
        Parameters:
        instance - instance, may be null.
        element - element, may not be null.
        props - properties
        Since:
        1.2.15

      • parseAppender

        protected org.apache.log4j.Appender parseAppender​(org.w3c.dom.Element appenderElement)
        Used internally to parse an appender element.

      • parseErrorHandler

        protected void parseErrorHandler​(org.w3c.dom.Element element,
                                 org.apache.log4j.Appender appender)
        Used internally to parse an ErrorHandler element.

      • parseFilters

        protected void parseFilters​(org.w3c.dom.Element element,
                            org.apache.log4j.Appender appender)
        Used internally to parse a filter element.

      • parseCategory

        protected void parseCategory​(org.w3c.dom.Element loggerElement)
        Used internally to parse an category element.

      • parseCategoryFactory

        protected void parseCategoryFactory​(org.w3c.dom.Element factoryElement)
        Used internally to parse the category factory element.

      • parseRoot

        protected void parseRoot​(org.w3c.dom.Element rootElement)
        Used internally to parse the roor category element.

      • parseChildrenOfLoggerElement

        protected void parseChildrenOfLoggerElement​(org.w3c.dom.Element catElement,
                                            org.apache.log4j.Logger cat,
                                            boolean isRoot)
        Used internally to parse the children of a category element.

      • parseLayout

        protected org.apache.log4j.Layout parseLayout​(org.w3c.dom.Element layout_element)
        Used internally to parse a layout element.

      • parseRenderer

        protected void parseRenderer​(org.w3c.dom.Element element)

      • parseLevel

        protected void parseLevel​(org.w3c.dom.Element element,
                          org.apache.log4j.Logger logger,
                          boolean isRoot)
        Used internally to parse a level element.

      • setParameter

        protected void setParameter​(org.w3c.dom.Element elem,
                            org.apache.log4j.config.PropertySetter propSetter)

      • configure

        public static void configure​(org.w3c.dom.Element element)
        Configure log4j using a configuration element as defined in the log4j.dtd.

      • configureAndWatch

        public static void configureAndWatch​(java.lang.String configFilename)
        Like configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
        Parameters:
        configFilename - A log4j configuration file in XML format.

      • configureAndWatch

        public static void configureAndWatch​(java.lang.String configFilename,
                                     long delay)
        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 log4j.
        Parameters:
        configFilename - A log4j configuration file in XML format.
        delay - The delay in milliseconds to wait between each check.

      • doConfigure

        public void doConfigure​(java.lang.String filename,
                        org.apache.log4j.spi.LoggerRepository repository)

      • doConfigure

        public void doConfigure​(java.net.URL url,
                        org.apache.log4j.spi.LoggerRepository repository)
        Specified by:
        doConfigure in interface org.apache.log4j.spi.Configurator

      • doConfigure

        public void doConfigure​(java.io.InputStream inputStream,
                        org.apache.log4j.spi.LoggerRepository repository)
                 throws javax.xml.parsers.FactoryConfigurationError
        Configure log4j by reading in a log4j.dtd compliant XML configuration file.
        Specified by:
        doConfigure in interface org.apache.log4j.spi.Configurator
        Throws:
        javax.xml.parsers.FactoryConfigurationError

      • doConfigure

        public void doConfigure​(java.io.Reader reader,
                        org.apache.log4j.spi.LoggerRepository repository)
                 throws javax.xml.parsers.FactoryConfigurationError
        Configure log4j by reading in a log4j.dtd compliant XML configuration file.
        Throws:
        javax.xml.parsers.FactoryConfigurationError

      • doConfigure

        protected void doConfigure​(org.xml.sax.InputSource inputSource,
                           org.apache.log4j.spi.LoggerRepository repository)
                    throws javax.xml.parsers.FactoryConfigurationError
        Configure log4j by reading in a log4j.dtd compliant XML configuration file.
        Throws:
        javax.xml.parsers.FactoryConfigurationError

      • doConfigure

        private final void doConfigure​(DOMConfigurator.ParseAction action,
                               org.apache.log4j.spi.LoggerRepository repository)
                        throws javax.xml.parsers.FactoryConfigurationError
        Throws:
        javax.xml.parsers.FactoryConfigurationError

      • doConfigure

        public void doConfigure​(org.w3c.dom.Element element,
                        org.apache.log4j.spi.LoggerRepository repository)
        Configure by taking in an DOM element.

      • configure

        public static void configure​(java.lang.String filename)
                      throws javax.xml.parsers.FactoryConfigurationError
        A static version of doConfigure(String, LoggerRepository).
        Throws:
        javax.xml.parsers.FactoryConfigurationError

      • configure

        public static void configure​(java.net.URL url)
                      throws javax.xml.parsers.FactoryConfigurationError
        A static version of doConfigure(URL, LoggerRepository).
        Throws:
        javax.xml.parsers.FactoryConfigurationError

      • parse

        protected void parse​(org.w3c.dom.Element element)
        Used internally to configure the log4j framework by parsing a DOM tree of XML elements based on log4j.dtd.

      • subst

        protected java.lang.String subst​(java.lang.String value)

      • subst

        public static java.lang.String subst​(java.lang.String value,
                                     java.util.Properties props)
        Substitutes property value for any references in expression.
        Parameters:
        value - value from configuration file, may contain literal text, property references or both
        props - properties.
        Returns:
        evaluated expression, may still contain expressions if unable to expand.
        Since:
        1.2.15

      • setParameter

        public static void setParameter​(org.w3c.dom.Element elem,
                                org.apache.log4j.config.PropertySetter propSetter,
                                java.util.Properties props)
        Sets a parameter based from configuration file content.
        Parameters:
        elem - param element, may not be null.
        propSetter - property setter, may not be null.
        props - properties
        Since:
        1.2.15

      • parseElement

        public static org.apache.log4j.spi.OptionHandler parseElement​(org.w3c.dom.Element element,
                                                              java.util.Properties props,
                                                              java.lang.Class expectedClass)
                                                       throws java.lang.Exception
        Creates an OptionHandler and processes any nested param elements but does not call activateOptions. If the class also supports UnrecognizedElementParser, the parseUnrecognizedElement method will be call for any child elements other than param.
        Parameters:
        element - element, may not be null.
        props - properties
        expectedClass - interface or class expected to be implemented by created class
        Returns:
        created class or null.
        Throws:
        java.lang.Exception - thrown if the contain object should be abandoned.
        Since:
        1.2.15