Package org.apache.logging.log4j.core.config

Class Configurator

  • public final class Configurator
extends java.lang.Object
    Initializes and configure the Logging system. This class provides several ways to construct a LoggerContext using the location of a configuration file, a context name, and various optional parameters.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String FQCN  
      private static Logger LOGGER  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Configurator()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static Log4jContextFactory getFactory()  
      static LoggerContext initialize​(java.lang.ClassLoader loader, Configuration configuration)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.ClassLoader loader, Configuration configuration, java.lang.Object externalContext)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.ClassLoader loader, ConfigurationSource source)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.ClassLoader loader, ConfigurationSource source, java.lang.Object externalContext)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.String name, java.lang.ClassLoader loader, java.lang.String configLocation)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.String name, java.lang.ClassLoader loader, java.lang.String configLocation, java.lang.Object externalContext)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.String name, java.lang.ClassLoader loader, java.net.URI configLocation)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.String name, java.lang.ClassLoader loader, java.net.URI configLocation, java.lang.Object externalContext)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.String name, java.lang.ClassLoader loader, java.net.URI configLocation, java.util.Map.Entry<java.lang.String,​java.lang.Object> entry)
      Initializes the Logging Context.
      static LoggerContext initialize​(java.lang.String name, java.lang.ClassLoader loader, java.util.List<java.net.URI> configLocations, java.lang.Object externalContext)  
      static LoggerContext initialize​(java.lang.String name, java.lang.String configLocation)
      Initializes the Logging Context.
      static LoggerContext initialize​(Configuration configuration)
      Initializes the Logging Context.
      static void reconfigure()
      Reload the existing reconfiguration.
      static void reconfigure​(java.net.URI uri)
      Reconfigure with a potentially new configuration.
      static void reconfigure​(Configuration configuration)
      Reconfigure using an already constructed Configuration.
      static void setAllLevels​(java.lang.String parentLogger, Level level)
      Sets the levels of parentLogger and all 'child' loggers to the given level.
      static void setLevel​(java.lang.Class<?> clazz, Level level)
      Sets a logger's level.
      static void setLevel​(java.lang.String loggerName, java.lang.String level)
      Sets a logger's level.
      static void setLevel​(java.lang.String loggerName, Level level)
      Sets a logger's level.
      private static boolean setLevel​(java.lang.String loggerName, Level level, Configuration config)  
      static void setLevel​(java.util.Map<java.lang.String,​Level> levelMap)
      Sets logger levels.
      private static boolean setLevel​(LoggerConfig loggerConfig, Level level)  
      private static void setLevel​(LoggerContext loggerContext, java.lang.String loggerName, Level level)  
      static Logger setLevel​(Logger logger, Level level)
      Sets a logger's level.
      static void setRootLevel​(Level level)
      Sets the root logger's level.
      private static void setRootLevel​(Level level, LoggerContext loggerContext)  
      static void shutdown​(LoggerContext ctx)
      Shuts down the given logger context.
      static boolean shutdown​(LoggerContext ctx, long timeout, java.util.concurrent.TimeUnit timeUnit)
      Shuts down the given logger context.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • FQCN

        private static final java.lang.String FQCN

      • LOGGER

        private static final Logger LOGGER

    • Constructor Detail

      • Configurator

        private Configurator()

    • Method Detail

      • initialize

        public static LoggerContext initialize​(java.lang.ClassLoader loader,
                                       ConfigurationSource source)
        Initializes the Logging Context.
        Parameters:
        loader - The ClassLoader for the Context (or null).
        source - The InputSource for the configuration.
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.ClassLoader loader,
                                       ConfigurationSource source,
                                       java.lang.Object externalContext)
        Initializes the Logging Context.
        Parameters:
        loader - The ClassLoader for the Context (or null).
        source - The InputSource for the configuration.
        externalContext - The external context to be attached to the LoggerContext.
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.ClassLoader loader,
                                       java.lang.String configLocation)
        Initializes the Logging Context.
        Parameters:
        name - The Context name.
        loader - The ClassLoader for the Context (or null).
        configLocation - The configuration for the logging context.
        Returns:
        The LoggerContext or null if an error occurred (check the status logger).

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.ClassLoader loader,
                                       java.lang.String configLocation,
                                       java.lang.Object externalContext)
        Initializes the Logging Context.
        Parameters:
        name - The Context name.
        loader - The ClassLoader for the Context (or null).
        configLocation - The configuration for the logging context (or null, or blank).
        externalContext - The external context to be attached to the LoggerContext
        Returns:
        The LoggerContext or null if an error occurred (check the status logger).

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.ClassLoader loader,
                                       java.net.URI configLocation)
        Initializes the Logging Context.
        Parameters:
        name - The Context name.
        loader - The ClassLoader for the Context (or null).
        configLocation - The configuration for the logging context.
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.ClassLoader loader,
                                       java.net.URI configLocation,
                                       java.lang.Object externalContext)
        Initializes the Logging Context.
        Parameters:
        name - The Context name.
        loader - The ClassLoader for the Context (or null).
        configLocation - The configuration for the logging context (or null).
        externalContext - The external context to be attached to the LoggerContext
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.ClassLoader loader,
                                       java.net.URI configLocation,
                                       java.util.Map.Entry<java.lang.String,​java.lang.Object> entry)
        Initializes the Logging Context.
        Parameters:
        name - The Context name.
        loader - The ClassLoader for the Context (or null).
        configLocation - The configuration for the logging context (or null).
        entry - The external context entry to be attached to the LoggerContext
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.ClassLoader loader,
                                       java.util.List<java.net.URI> configLocations,
                                       java.lang.Object externalContext)

      • initialize

        public static LoggerContext initialize​(java.lang.String name,
                                       java.lang.String configLocation)
        Initializes the Logging Context.
        Parameters:
        name - The Context name.
        configLocation - The configuration for the logging context.
        Returns:
        The LoggerContext or null if an error occurred (check the status logger).

      • initialize

        public static LoggerContext initialize​(Configuration configuration)
        Initializes the Logging Context.
        Parameters:
        configuration - The Configuration.
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.ClassLoader loader,
                                       Configuration configuration)
        Initializes the Logging Context.
        Parameters:
        loader - The ClassLoader.
        configuration - The Configuration.
        Returns:
        The LoggerContext.

      • initialize

        public static LoggerContext initialize​(java.lang.ClassLoader loader,
                                       Configuration configuration,
                                       java.lang.Object externalContext)
        Initializes the Logging Context.
        Parameters:
        loader - The ClassLoader.
        configuration - The Configuration.
        externalContext - - The external context to be attached to the LoggerContext.
        Returns:
        The LoggerContext.

      • reconfigure

        public static void reconfigure​(Configuration configuration)
        Reconfigure using an already constructed Configuration.
        Parameters:
        configuration - The configuration.
        Since:
        2.13.0

      • reconfigure

        public static void reconfigure()
        Reload the existing reconfiguration.
        Since:
        2.12.0

      • reconfigure

        public static void reconfigure​(java.net.URI uri)
        Reconfigure with a potentially new configuration.
        Parameters:
        uri - The location of the configuration.
        Since:
        2.12.0

      • setAllLevels

        public static void setAllLevels​(java.lang.String parentLogger,
                                Level level)
        Sets the levels of parentLogger and all 'child' loggers to the given level.
        Parameters:
        parentLogger - the parent logger
        level - the new level

      • setLevel

        public static Logger setLevel​(Logger logger,
                              Level level)
        Sets a logger's level.
        Parameters:
        logger - the logger
        level - the new level
        Returns:
        the given logger

      • setLevel

        public static void setLevel​(java.lang.Class<?> clazz,
                            Level level)
        Sets a logger's level.
        Parameters:
        clazz - the logger
        level - the new level

      • setLevel

        private static boolean setLevel​(LoggerConfig loggerConfig,
                                Level level)

      • setLevel

        private static void setLevel​(LoggerContext loggerContext,
                             java.lang.String loggerName,
                             Level level)

      • setLevel

        public static void setLevel​(java.util.Map<java.lang.String,​Level> levelMap)
        Sets logger levels.
        Parameters:
        levelMap - a levelMap where keys are level names and values are new Levels.

      • setLevel

        public static void setLevel​(java.lang.String loggerName,
                            Level level)
        Sets a logger's level.
        Parameters:
        loggerName - the logger name
        level - the new level

      • setLevel

        public static void setLevel​(java.lang.String loggerName,
                            java.lang.String level)
        Sets a logger's level.
        Parameters:
        loggerName - the logger name
        level - the new level

      • setLevel

        private static boolean setLevel​(java.lang.String loggerName,
                                Level level,
                                Configuration config)

      • setRootLevel

        public static void setRootLevel​(Level level)
        Sets the root logger's level.
        Parameters:
        level - the new level

      • setRootLevel

        private static void setRootLevel​(Level level,
                                 LoggerContext loggerContext)

      • shutdown

        public static void shutdown​(LoggerContext ctx)
        Shuts down the given logger context. This request does not wait for Log4j tasks to complete.

        Log4j starts threads to perform certain actions like file rollovers; calling this method will not wait until the rollover thread is done. When this method returns, these tasks' status are undefined, the tasks may be done or not.

        Parameters:
        ctx - the logger context to shut down, may be null.

      • shutdown

        public static boolean shutdown​(LoggerContext ctx,
                               long timeout,
                               java.util.concurrent.TimeUnit timeUnit)
        Shuts down the given logger context.

        Log4j can start threads to perform certain actions like file rollovers; calling this method with a positive timeout will block until the rollover thread is done.

        Parameters:
        ctx - the logger context to shut down, may be null.
        timeout - the maximum time to wait
        timeUnit - the time unit of the timeout argument
        Returns:
        true if the logger context terminated and false if the timeout elapsed before termination.
        Since:
        2.7
        See Also:
        LoggerContext.stop(long, TimeUnit)