AbstractLoggingSystem (spring-boot 2.3.6.RELEASE)

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

Direct Known Subclasses:

JavaLoggingSystem, Slf4JLoggingSystem
```
public abstract class AbstractLoggingSystem
extends LoggingSystem
```
Abstract base class for LoggingSystem implementations.

Since:

1.0.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractLoggingSystem.LogLevels<T>
Maintains a mapping between native levels and LogLevel.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractLoggingSystem.LogLevels<T>` Maintains a mapping between native levels and `LogLevel`.

Field Summary

Fields
Modifier and Type Field and Description

protected static java.util.Comparator<LoggerConfiguration> CONFIGURATION_COMPARATOR
- Fields inherited from class org.springframework.boot.logging.LoggingSystem
  NONE, ROOT_LOGGER_NAME, SYSTEM_PROPERTY

Fields
Modifier and Type	Field and Description
`protected static java.util.Comparator<LoggerConfiguration>`	`CONFIGURATION_COMPARATOR`

Constructor Summary

Constructors
Constructor and Description

AbstractLoggingSystem(java.lang.ClassLoader classLoader)

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`applySystemProperties(org.springframework.core.env.Environment environment, LogFile logFile)`
`void`	`beforeInitialize()` Reset the logging system to be limit output.
`protected java.lang.ClassLoader`	`getClassLoader()`
`protected java.lang.String`	`getPackagedConfigFile(java.lang.String fileName)`
`protected java.lang.String`	`getSelfInitializationConfig()` Return any self initialization config that has been applied.
`protected java.lang.String[]`	`getSpringConfigLocations()` Return the spring config locations for this system.
`protected java.lang.String`	`getSpringInitializationConfig()` Return any spring specific initialization config that should be applied.
`protected abstract java.lang.String[]`	`getStandardConfigLocations()` Return the standard config locations for this system.
`void`	`initialize(LoggingInitializationContext initializationContext, java.lang.String configLocation, LogFile logFile)` Fully initialize the logging system.
`protected abstract void`	`loadConfiguration(LoggingInitializationContext initializationContext, java.lang.String location, LogFile logFile)` Load a specific configuration.
`protected abstract void`	`loadDefaults(LoggingInitializationContext initializationContext, LogFile logFile)` Load sensible defaults for the logging system.
`protected void`	`reinitialize(LoggingInitializationContext initializationContext)` Reinitialize the logging system if required.

Methods inherited from class org.springframework.boot.logging.LoggingSystem
cleanUp, get, getLoggerConfiguration, getLoggerConfigurations, getShutdownHandler, getSupportedLogLevels, setLogLevel

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

- Field Detail
  - CONFIGURATION_COMPARATOR
```
protected static final java.util.Comparator<LoggerConfiguration> CONFIGURATION_COMPARATOR
```
- Constructor Detail
  - AbstractLoggingSystem
```
public AbstractLoggingSystem(java.lang.ClassLoader classLoader)
```
- Method Detail
  - 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.
    
    Specified by:
    
    beforeInitialize in class LoggingSystem
  - 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 LoggingSystem
    
    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
  - getSelfInitializationConfig
```
protected java.lang.String getSelfInitializationConfig()
```
    Return any self initialization config that has been applied. By default this method checks getStandardConfigLocations() and assumes that any file that exists will have been applied.
    
    Returns:
    
    the self initialization config or null
  - getSpringInitializationConfig
```
protected java.lang.String getSpringInitializationConfig()
```
    Return any spring specific initialization config that should be applied. By default this method checks getSpringConfigLocations().
    
    Returns:
    
    the spring initialization config or null
  - getStandardConfigLocations
```
protected abstract java.lang.String[] getStandardConfigLocations()
```
    Return the standard config locations for this system.
    
    Returns:
    
    the standard config locations
    
    See Also:
    
    getSelfInitializationConfig()
  - getSpringConfigLocations
```
protected java.lang.String[] getSpringConfigLocations()
```
    Return the spring config locations for this system. By default this method returns a set of locations based on getStandardConfigLocations().
    
    Returns:
    
    the spring config locations
    
    See Also:
    
    getSpringInitializationConfig()
  - loadDefaults
```
protected abstract void loadDefaults(LoggingInitializationContext initializationContext,
                                     LogFile logFile)
```
    Load sensible defaults for the logging system.
    
    Parameters:
    
    initializationContext - the logging initialization context
    
    logFile - the file to load or null if no log file is to be written
  - loadConfiguration
```
protected abstract void loadConfiguration(LoggingInitializationContext initializationContext,
                                          java.lang.String location,
                                          LogFile logFile)
```
    Load a specific configuration.
    
    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
  - reinitialize
```
protected void reinitialize(LoggingInitializationContext initializationContext)
```
    Reinitialize the logging system if required. Called when getSelfInitializationConfig() is used and the log file hasn't changed. May be used to reload configuration (for example to pick up additional System properties).
    
    Parameters:
    
    initializationContext - the logging initialization context
  - getClassLoader
```
protected final java.lang.ClassLoader getClassLoader()
```
  - getPackagedConfigFile
```
protected final java.lang.String getPackagedConfigFile(java.lang.String fileName)
```
  - applySystemProperties
```
protected final void applySystemProperties(org.springframework.core.env.Environment environment,
                                           LogFile logFile)
```

Class AbstractLoggingSystem

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CONFIGURATION_COMPARATOR

Constructor Detail

AbstractLoggingSystem

Method Detail

beforeInitialize

initialize

getSelfInitializationConfig

getSpringInitializationConfig

getStandardConfigLocations

getSpringConfigLocations

loadDefaults

loadConfiguration

reinitialize

getClassLoader

getPackagedConfigFile

applySystemProperties