LoggingSystem (spring-boot 2.2.13.RELEASE)

java.lang.Object
- org.springframework.boot.logging.LoggingSystem

Direct Known Subclasses:

AbstractLoggingSystem
```
public abstract class LoggingSystem
extends Object
```
Common abstraction over logging systems.

Since:

1.0.0

Author:

Phillip Webb, Dave Syer, Andy Wilkinson, Ben Hale

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NONE` The value of the `SYSTEM_PROPERTY` that can be used to indicate that no `LoggingSystem` should be used.
`static String`	`ROOT_LOGGER_NAME` The name used for the root logger.
`static String`	`SYSTEM_PROPERTY` A System property that can be used to indicate the `LoggingSystem` to use.

Constructor Summary

Constructors
Constructor and Description

LoggingSystem()

Constructors
Constructor and Description
`LoggingSystem()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`beforeInitialize()` Reset the logging system to be limit output.
`void`	`cleanUp()` Clean up the logging system.
`static LoggingSystem`	`get(ClassLoader classLoader)` Detect and return the logging system in use.
`LoggerConfiguration`	`getLoggerConfiguration(String loggerName)` Returns the current configuration for a `LoggingSystem`'s logger.
`List<LoggerConfiguration>`	`getLoggerConfigurations()` Returns a collection of the current configuration for all a `LoggingSystem`'s loggers.
`Runnable`	`getShutdownHandler()` Returns a `Runnable` that can handle shutdown of this logging system when the JVM exits.
`Set<LogLevel>`	`getSupportedLogLevels()` Returns a set of the `LogLevels` that are actually supported by the logging system.
`void`	`initialize(LoggingInitializationContext initializationContext, String configLocation, LogFile logFile)` Fully initialize the logging system.
`void`	`setLogLevel(String loggerName, LogLevel level)` Sets the logging level for a given logger.

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

- Field Detail
  - SYSTEM_PROPERTY
```
public static final String SYSTEM_PROPERTY
```
    A System property that can be used to indicate the LoggingSystem to use.
  - NONE
```
public static final String NONE
```
    The value of the SYSTEM_PROPERTY that can be used to indicate that no LoggingSystem should be used.
    
    See Also:
    
    Constant Field Values
  - ROOT_LOGGER_NAME
```
public static final String ROOT_LOGGER_NAME
```
    The name used for the root logger. LoggingSystem implementations should ensure that this is the name used to represent the root logger, regardless of the underlying implementation.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoggingSystem
```
public LoggingSystem()
```
- Method Detail
  - beforeInitialize
```
public abstract void beforeInitialize()
```
    Reset the logging system to be limit output. This method may be called before initialize(LoggingInitializationContext, String, LogFile) to reduce logging noise until the system has been fully initialized.
  - initialize
```
public void initialize(LoggingInitializationContext initializationContext,
                       String configLocation,
                       LogFile logFile)
```
    Fully initialize the logging system.
    
    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
  - cleanUp
```
public void cleanUp()
```
    Clean up the logging system. The default implementation does nothing. Subclasses should override this method to perform any logging system-specific cleanup.
  - getShutdownHandler
```
public Runnable getShutdownHandler()
```
    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.
    
    Returns:
    
    the shutdown handler, or null
  - getSupportedLogLevels
```
public Set<LogLevel> getSupportedLogLevels()
```
    Returns a set of the LogLevels that are actually supported by the logging system.
    
    Returns:
    
    the supported levels
  - setLogLevel
```
public void setLogLevel(String loggerName,
                        LogLevel level)
```
    Sets the logging level for a given logger.
    
    Parameters:
    
    loggerName - the name of the logger to set (null can be used for the root logger).
    
    level - the log level (null can be used to remove any custom level for the logger and use the default configuration instead)
  - getLoggerConfigurations
```
public List<LoggerConfiguration> getLoggerConfigurations()
```
    Returns a collection of the current configuration for all a LoggingSystem's loggers.
    
    Returns:
    
    the current configurations
    
    Since:
    
    1.5.0
  - getLoggerConfiguration
```
public LoggerConfiguration getLoggerConfiguration(String loggerName)
```
    Returns the current configuration for a LoggingSystem's logger.
    
    Parameters:
    
    loggerName - the name of the logger
    
    Returns:
    
    the current configuration
    
    Since:
    
    1.5.0
  - get
```
public static LoggingSystem get(ClassLoader classLoader)
```
    Detect and return the logging system in use. Supports Logback and Java Logging.
    
    Parameters:
    
    classLoader - the classloader
    
    Returns:
    
    the logging system

Class LoggingSystem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSTEM_PROPERTY

NONE

ROOT_LOGGER_NAME

Constructor Detail

LoggingSystem

Method Detail

beforeInitialize

initialize

cleanUp

getShutdownHandler

getSupportedLogLevels

setLogLevel

getLoggerConfigurations

getLoggerConfiguration

get