Log4J2LoggingSystem (spring-boot 2.4.4)

java.lang.Object
- org.springframework.boot.logging.LoggingSystem
- - org.springframework.boot.logging.AbstractLoggingSystem
  - - org.springframework.boot.logging.Slf4JLoggingSystem
    - - org.springframework.boot.logging.log4j2.Log4J2LoggingSystem

public class Log4J2LoggingSystem
extends Slf4JLoggingSystem

LoggingSystem for Log4j 2.

Since:: 1.2.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Log4J2LoggingSystem.Factory
LoggingSystemFactory that returns Log4J2LoggingSystem if possible.
- Nested classes/interfaces inherited from class org.springframework.boot.logging.AbstractLoggingSystem
  AbstractLoggingSystem.LogLevels<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Log4J2LoggingSystem.Factory` `LoggingSystemFactory` that returns `Log4J2LoggingSystem` if possible.

Field Summary
- Fields inherited from class org.springframework.boot.logging.AbstractLoggingSystem
  CONFIGURATION_COMPARATOR
- Fields inherited from class org.springframework.boot.logging.LoggingSystem
  NONE, ROOT_LOGGER_NAME, SYSTEM_PROPERTY

Constructor Summary

Constructors
Constructor and Description

Log4J2LoggingSystem(java.lang.ClassLoader classLoader)

Constructors
Constructor and Description
`Log4J2LoggingSystem(java.lang.ClassLoader classLoader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beforeInitialize()` Reset the logging system to be limit output.
`void`	`cleanUp()` Clean up the logging system.
`LoggerConfiguration`	`getLoggerConfiguration(java.lang.String loggerName)` Returns the current configuration for a `LoggingSystem`'s logger.
`java.util.List<LoggerConfiguration>`	`getLoggerConfigurations()` Returns a collection of the current configuration for all a `LoggingSystem`'s loggers.
`java.lang.Runnable`	`getShutdownHandler()` Returns a `Runnable` that can handle shutdown of this logging system when the JVM exits.
`protected java.lang.String[]`	`getStandardConfigLocations()` Return the standard config locations for this system.
`java.util.Set<LogLevel>`	`getSupportedLogLevels()` Returns a set of the `LogLevels` that are actually supported by the logging system.
`void`	`initialize(LoggingInitializationContext initializationContext, java.lang.String configLocation, LogFile logFile)` Fully initialize the logging system.
`protected boolean`	`isClassAvailable(java.lang.String className)`
`protected void`	`loadConfiguration(LoggingInitializationContext initializationContext, java.lang.String location, LogFile logFile)` Load a specific configuration.
`protected void`	`loadConfiguration(java.lang.String location, LogFile logFile)`
`protected void`	`loadDefaults(LoggingInitializationContext initializationContext, LogFile logFile)` Load sensible defaults for the logging system.
`protected void`	`reinitialize(LoggingInitializationContext initializationContext)` Reinitialize the logging system if required.
`void`	`setLogLevel(java.lang.String loggerName, LogLevel logLevel)` Sets the logging level for a given logger.

Methods inherited from class org.springframework.boot.logging.Slf4JLoggingSystem
isBridgeHandlerAvailable, isBridgeJulIntoSlf4j

Methods inherited from class org.springframework.boot.logging.AbstractLoggingSystem
applySystemProperties, getClassLoader, getPackagedConfigFile, getSelfInitializationConfig, getSpringConfigLocations, getSpringInitializationConfig

Methods inherited from class org.springframework.boot.logging.LoggingSystem
get, getSystemProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Log4J2LoggingSystem
```
public Log4J2LoggingSystem(java.lang.ClassLoader classLoader)
```
- Method Detail
  - getStandardConfigLocations
```
protected java.lang.String[] getStandardConfigLocations()
```
    Description copied from class: AbstractLoggingSystem
    
    Return the standard config locations for this system.
    
    Specified by:
    
    getStandardConfigLocations in class AbstractLoggingSystem
    
    Returns:
    
    the standard config locations
    
    See Also:
    
    AbstractLoggingSystem.getSelfInitializationConfig()
  - isClassAvailable
```
protected boolean isClassAvailable(java.lang.String className)
```
  - beforeInitialize
```
public void beforeInitialize()
```
    Description copied from class: LoggingSystem
    
    Reset the logging system to be limit output. This method may be called before LoggingSystem.initialize(LoggingInitializationContext, String, LogFile) to reduce logging noise until the system has been fully initialized.
    
    Overrides:
    
    beforeInitialize in class Slf4JLoggingSystem
  - initialize
```
public void initialize(LoggingInitializationContext initializationContext,
                       java.lang.String configLocation,
                       LogFile logFile)
```
    Description copied from class: LoggingSystem
    
    Fully initialize the logging system.
    
    Overrides:
    
    initialize in class AbstractLoggingSystem
    
    Parameters:
    
    initializationContext - the logging initialization context
    
    configLocation - a log configuration location or null if default initialization is required
    
    logFile - the log output file that should be written or null for console only output
  - loadDefaults
```
protected void loadDefaults(LoggingInitializationContext initializationContext,
                            LogFile logFile)
```
    Description copied from class: AbstractLoggingSystem
    
    Load sensible defaults for the logging system.
    
    Specified by:
    
    loadDefaults in class AbstractLoggingSystem
    
    Parameters:
    
    initializationContext - the logging initialization context
    
    logFile - the file to load or null if no log file is to be written
  - loadConfiguration
```
protected void loadConfiguration(LoggingInitializationContext initializationContext,
                                 java.lang.String location,
                                 LogFile logFile)
```
    Description copied from class: AbstractLoggingSystem
    
    Load a specific configuration.
    
    Overrides:
    
    loadConfiguration in class Slf4JLoggingSystem
    
    Parameters:
    
    initializationContext - the logging initialization context
    
    location - the location of the configuration to load (never null)
    
    logFile - the file to load or null if no log file is to be written
  - loadConfiguration
```
protected void loadConfiguration(java.lang.String location,
                                 LogFile logFile)
```
  - reinitialize
```
protected void reinitialize(LoggingInitializationContext initializationContext)
```
    Description copied from class: AbstractLoggingSystem
    
    Reinitialize the logging system if required. Called when AbstractLoggingSystem.getSelfInitializationConfig() is used and the log file hasn't changed. May be used to reload configuration (for example to pick up additional System properties).
    
    Overrides:
    
    reinitialize in class AbstractLoggingSystem
    
    Parameters:
    
    initializationContext - the logging initialization context
  - getSupportedLogLevels
```
public java.util.Set<LogLevel> getSupportedLogLevels()
```
    Description copied from class: LoggingSystem
    
    Returns a set of the LogLevels that are actually supported by the logging system.
    
    Overrides:
    
    getSupportedLogLevels in class LoggingSystem
    
    Returns:
    
    the supported levels
  - setLogLevel
```
public void setLogLevel(java.lang.String loggerName,
                        LogLevel logLevel)
```
    Description copied from class: LoggingSystem
    
    Sets the logging level for a given logger.
    
    Overrides:
    
    setLogLevel in class LoggingSystem
    
    Parameters:
    
    loggerName - the name of the logger to set (null can be used for the root logger).
    
    logLevel - the log level (null can be used to remove any custom level for the logger and use the default configuration instead)
  - getLoggerConfigurations
```
public java.util.List<LoggerConfiguration> getLoggerConfigurations()
```
    Description copied from class: LoggingSystem
    
    Returns a collection of the current configuration for all a LoggingSystem's loggers.
    
    Overrides:
    
    getLoggerConfigurations in class LoggingSystem
    
    Returns:
    
    the current configurations
  - getLoggerConfiguration
```
public LoggerConfiguration getLoggerConfiguration(java.lang.String loggerName)
```
    Description copied from class: LoggingSystem
    
    Returns the current configuration for a LoggingSystem's logger.
    
    Overrides:
    
    getLoggerConfiguration in class LoggingSystem
    
    Parameters:
    
    loggerName - the name of the logger
    
    Returns:
    
    the current configuration
  - getShutdownHandler
```
public java.lang.Runnable getShutdownHandler()
```
    Description copied from class: LoggingSystem
    
    Returns a Runnable that can handle shutdown of this logging system when the JVM exits. The default implementation returns null, indicating that no shutdown is required.
    
    Overrides:
    
    getShutdownHandler in class LoggingSystem
    
    Returns:
    
    the shutdown handler, or null
  - cleanUp
```
public void cleanUp()
```
    Description copied from class: LoggingSystem
    
    Clean up the logging system. The default implementation does nothing. Subclasses should override this method to perform any logging system-specific cleanup.
    
    Overrides:
    
    cleanUp in class Slf4JLoggingSystem

Class Log4J2LoggingSystem

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.logging.AbstractLoggingSystem

Field Summary

Fields inherited from class org.springframework.boot.logging.AbstractLoggingSystem

Fields inherited from class org.springframework.boot.logging.LoggingSystem

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.logging.Slf4JLoggingSystem

Methods inherited from class org.springframework.boot.logging.AbstractLoggingSystem

Methods inherited from class org.springframework.boot.logging.LoggingSystem

Methods inherited from class java.lang.Object

Constructor Detail

Log4J2LoggingSystem

Method Detail

getStandardConfigLocations

isClassAvailable

beforeInitialize

initialize

loadDefaults

loadConfiguration

loadConfiguration

reinitialize

getSupportedLogLevels

setLogLevel

getLoggerConfigurations

getLoggerConfiguration

getShutdownHandler

cleanUp