Package org.springframework.boot.logging
Class AbstractLoggingSystem
- 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 forLoggingSystem
implementations.
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AbstractLoggingSystem.LogLevels<T>
Maintains a mapping between native levels andLogLevel
.
Field Summary
Fields Modifier and Type Field Description protected static Comparator<LoggerConfiguration>
CONFIGURATION_COMPARATOR
Fields inherited from class org.springframework.boot.logging.LoggingSystem
NONE, ROOT_LOGGER_NAME, SYSTEM_PROPERTY
Constructor Summary
Constructors Constructor Description AbstractLoggingSystem(ClassLoader classLoader)
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
applySystemProperties(org.springframework.core.env.Environment environment, LogFile logFile)
void
beforeInitialize()
Reset the logging system to be limit output.protected ClassLoader
getClassLoader()
protected String
getPackagedConfigFile(String fileName)
protected String
getSelfInitializationConfig()
Return any self initialization config that has been applied.protected String[]
getSpringConfigLocations()
Return the spring config locations for this system.protected String
getSpringInitializationConfig()
Return any spring specific initialization config that should be applied.protected abstract String[]
getStandardConfigLocations()
Return the standard config locations for this system.void
initialize(LoggingInitializationContext initializationContext, String configLocation, LogFile logFile)
Fully initialize the logging system.protected abstract void
loadConfiguration(LoggingInitializationContext initializationContext, 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
Field Detail
CONFIGURATION_COMPARATOR
protected static final Comparator<LoggerConfiguration> CONFIGURATION_COMPARATOR
Constructor Detail
AbstractLoggingSystem
public AbstractLoggingSystem(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 beforeLoggingSystem.initialize(LoggingInitializationContext, String, LogFile)
to reduce logging noise until the system has been fully initialized.- Specified by:
beforeInitialize
in classLoggingSystem
initialize
public void initialize(LoggingInitializationContext initializationContext, String configLocation, LogFile logFile)
Description copied from class:LoggingSystem
Fully initialize the logging system.- Overrides:
initialize
in classLoggingSystem
- Parameters:
initializationContext
- the logging initialization contextconfigLocation
- a log configuration location ornull
if default initialization is requiredlogFile
- the log output file that should be written ornull
for console only output
getSelfInitializationConfig
protected String getSelfInitializationConfig()
Return any self initialization config that has been applied. By default this method checksgetStandardConfigLocations()
and assumes that any file that exists will have been applied.- Returns:
- the self initialization config or
null
getSpringInitializationConfig
protected String getSpringInitializationConfig()
Return any spring specific initialization config that should be applied. By default this method checksgetSpringConfigLocations()
.- Returns:
- the spring initialization config or
null
getStandardConfigLocations
protected abstract String[] getStandardConfigLocations()
Return the standard config locations for this system.- Returns:
- the standard config locations
- See Also:
getSelfInitializationConfig()
getSpringConfigLocations
protected String[] getSpringConfigLocations()
Return the spring config locations for this system. By default this method returns a set of locations based ongetStandardConfigLocations()
.- 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 contextlogFile
- the file to load ornull
if no log file is to be written
loadConfiguration
protected abstract void loadConfiguration(LoggingInitializationContext initializationContext, String location, LogFile logFile)
Load a specific configuration.- Parameters:
initializationContext
- the logging initialization contextlocation
- the location of the configuration to load (nevernull
)logFile
- the file to load ornull
if no log file is to be written
reinitialize
protected void reinitialize(LoggingInitializationContext initializationContext)
Reinitialize the logging system if required. Called whengetSelfInitializationConfig()
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 ClassLoader getClassLoader()
getPackagedConfigFile
protected final String getPackagedConfigFile(String fileName)
applySystemProperties
protected final void applySystemProperties(org.springframework.core.env.Environment environment, LogFile logFile)