org.springframework.boot.logging

Class LoggingSystem

java.lang.Object

org.springframework.boot.logging.LoggingSystem

Direct Known Subclasses:

AbstractLoggingSystem

public abstract class LoggingSystem
extends Object

Common abstraction over logging systems.

Author:

Phillip Webb, Dave Syer, Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_PROPERTY A System property that can be used to indicate the LoggingSystem to use.

Constructor Summary

Constructors

Constructor and Description
LoggingSystem()

Method Summary

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.
Runnable	getShutdownHandler() Returns a Runnable that can handle shutdown of this logging system when the JVM exits.
void	initialize(LoggingInitializationContext initializationContext, String configLocation, LogFile logFile) Fully initialize the logging system.
void	initialize(String configLocation, LogFile logFile) Deprecated. since 1.3 in favor of initialize(LoggingInitializationContext, String, LogFile)
abstract 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.

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

initialize

@Deprecated
public void initialize(String configLocation,
                                   LogFile logFile)

Deprecated. since 1.3 in favor of initialize(LoggingInitializationContext, String, LogFile)

Fully initialize the logging system.

Parameters:

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

setLogLevel

public abstract void setLogLevel(String loggerName,
                                 LogLevel level)

Sets the logging level for a given logger.

Parameters:

loggerName - the name of the logger to set

level - the log level

get

public static LoggingSystem get(ClassLoader classLoader)

Detect and return the logging system in use. Supports Logback, Log4J, Log4J2 and Java Logging.

Parameters:

classLoader - the classloader

Returns:

The logging system