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

Class StatusConfiguration

java.lang.Object
org.apache.logging.log4j.core.config.status.StatusConfiguration
public class StatusConfiguration extends Object
Configuration for setting up the StatusLogger fallback listener.

  • Field Details

    • LOGGER

      private static final StatusLogger LOGGER

    • lock

      private final Lock lock

    • initialized

      private volatile boolean initialized

    • output

      private @Nullable PrintStream output

    • level

      private @Nullable Level level

  • Constructor Details

    • StatusConfiguration

      public StatusConfiguration()

  • Method Details

    • error

      @Deprecated public void error(String message)
      Deprecated.
      Use StatusLogger.getLogger() and then AbstractLogger.error(String) instead.
      Logs an error message to the StatusLogger.
      Parameters:
      message - error message to log

    • withDestination

      public StatusConfiguration withDestination(@Nullable String destination)
      Sets the output of the StatusLogger fallback listener.

      Accepted values are as follows:

      Invalid values will be ignored.

      Parameters:
      destination - destination where StatusLogger messages should be output
      Returns:
      this

    • parseStreamName

      private static @Nullable PrintStream parseStreamName(@Nullable String name) throws URISyntaxException, FileNotFoundException
      Throws:
      URISyntaxException
      FileNotFoundException

    • withStatus

      public StatusConfiguration withStatus(@Nullable String level)
      Sets the level of the StatusLogger fallback listener.
      Parameters:
      level - a level name
      Returns:
      this

    • withStatus

      public StatusConfiguration withStatus(@Nullable Level level)
      Sets the level of the StatusLogger fallback listener.
      Parameters:
      level - a level
      Returns:
      this

    • withVerbosity

      @Deprecated public StatusConfiguration withVerbosity(String verbosity)
      Deprecated.
      This method is ineffective and only kept for binary backward compatibility.
      Specifies the verbosity level to log at. This only applies to classes configured by verboseClasses.
      Parameters:
      verbosity - basic filter for status logger messages.
      Returns:
      this

    • withVerboseClasses

      @Deprecated public StatusConfiguration withVerboseClasses(String... verboseClasses)
      Deprecated.
      This method is ineffective and only kept for binary backward compatibility.
      Specifies which class names to filter if the configured verbosity level is QUIET.
      Parameters:
      verboseClasses - names of classes to filter if not using VERBOSE.
      Returns:
      this

    • initialize

      public void initialize()
      Configures and initializes the StatusLogger using the configured options in this instance.