Package org.apache.log4j

Class PropertyConfigurator

java.lang.Object
org.apache.log4j.PropertyConfigurator
All Implemented Interfaces:
Configurator
public class PropertyConfigurator extends Object implements Configurator
Configures Log4j from properties.

  • Field Details

    • LOGGER_FACTORY_KEY

      public static final String LOGGER_FACTORY_KEY
      Key for specifying the LoggerFactory. Currently set to "log4j.loggerFactory".
      See Also:

    • registry

      protected Hashtable registry
      Used internally to keep track of configured appenders.

    • loggerFactory

      protected LoggerFactory loggerFactory

  • Constructor Details

    • PropertyConfigurator

      public PropertyConfigurator()

  • Method Details

    • configure

      public static void configure(InputStream inputStream)
      Reads configuration options from an InputStream.
      Parameters:
      inputStream - The input stream

    • configure

      public static void configure(Properties properties)
      Reads configuration options from properties. See doConfigure(String, LoggerRepository) for the expected format.
      Parameters:
      properties - The properties

    • configure

      public static void configure(String fileName)
      Reads configuration options from configuration file.
      Parameters:
      fileName - The configuration file.

    • configure

      public static void configure(URL configURL)
      Reads configuration options from url configURL.
      Parameters:
      configURL - The configuration URL

    • configureAndWatch

      public static void configureAndWatch(String configFilename)
      Like configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
      Parameters:
      configFilename - A file in key=value format.

    • configureAndWatch

      public static void configureAndWatch(String configFilename, long delayMillis)
      Reads 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 file in key=value format.
      delayMillis - The delay in milliseconds to wait between each check.

    • configureLoggerFactory

      protected void configureLoggerFactory(Properties properties)
      Checks the provided Properties object for a LoggerFactory entry specified by LOGGER_FACTORY_KEY. If such an entry exists, an attempt is made to create an instance using the default constructor. This instance is used for subsequent Category creations within this configurator.
      See Also:

    • doConfigure

      public void doConfigure(InputStream inputStream, LoggerRepository loggerRepository)
      Reads configuration options from an InputStream.
      Specified by:
      doConfigure in interface Configurator
      Parameters:
      inputStream - The input stream
      loggerRepository - The hierarchy

    • doConfigure

      public void doConfigure(Properties properties, LoggerRepository loggerRepository)
      Reads configuration options from properties. See doConfigure(String, LoggerRepository) for the expected format.
      Parameters:
      properties - The properties
      loggerRepository - The hierarchy

    • doConfigure

      public void doConfigure(String fileName, LoggerRepository loggerRepository)
      Reads configuration options from configuration file.
      Parameters:
      fileName - The configuration file
      loggerRepository - The hierarchy

    • doConfigure

      public void doConfigure(URL url, LoggerRepository loggerRepository)
      Read configuration options from url configURL.
      Specified by:
      doConfigure in interface Configurator
      Parameters:
      url - The configuration URL
      loggerRepository - The hierarchy

    • parseCatsAndRenderers

      protected void parseCatsAndRenderers(Properties properties, LoggerRepository loggerRepository)
      Parse non-root elements, such non-root categories and renderers.