JavaLoggingSystem (spring-boot 3.3.2)

org.springframework.boot.logging.java.JavaLoggingSystem

public class JavaLoggingSystem extends AbstractLoggingSystem

LoggingSystem for java.util.logging.

Since:: 1.0.0

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

JavaLoggingSystem.Factory

LoggingSystemFactory that returns JavaLoggingSystem if possible.

Nested classes/interfaces inherited from class org.springframework.boot.logging.AbstractLoggingSystem
AbstractLoggingSystem.LogLevels<T>
Field Summary

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

Fields inherited from class org.springframework.boot.logging.LoggingSystem
EXPECT_CORRELATION_ID_PROPERTY, NONE, ROOT_LOGGER_NAME, SYSTEM_PROPERTY
Constructor Summary

Constructors

Constructor

Description

JavaLoggingSystem(ClassLoader classLoader)
Method Summary

Modifier and Type

Method

Description

void

beforeInitialize()

Reset the logging system to be limit output.

void

cleanUp()

Clean up the logging system.

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.

protected String[]

getStandardConfigLocations()

Return the standard config locations for this system.

Set<LogLevel>

getSupportedLogLevels()

Returns a set of the LogLevels that are actually supported by the logging system.

protected void

loadConfiguration(String location, LogFile logFile)

protected void

loadConfiguration(LoggingInitializationContext initializationContext, String location, LogFile logFile)

Load a specific configuration.

protected void

loadDefaults(LoggingInitializationContext initializationContext, LogFile logFile)

Load sensible defaults for the logging system.

void

setLogLevel(String loggerName, LogLevel level)

Sets the logging level for a given logger.

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

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 Details
- JavaLoggingSystem
  
  public JavaLoggingSystem(ClassLoader classLoader)
Method Details
- getStandardConfigLocations
  
  protected 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()
- 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 AbstractLoggingSystem
- 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, String location, LogFile logFile)
  
  Description copied from class: AbstractLoggingSystem
  
  Load a specific configuration.
  
  Specified by:
  
  loadConfiguration in class AbstractLoggingSystem
  
  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(String location, LogFile logFile)
- getSupportedLogLevels
  
  public 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(String loggerName, LogLevel level)
  
  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).
  
  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()
  
  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(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 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 LoggingSystem

Class JavaLoggingSystem

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.AbstractLoggingSystem

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

Methods inherited from class java.lang.Object

Constructor Details

JavaLoggingSystem

Method Details

getStandardConfigLocations

beforeInitialize

loadDefaults

loadConfiguration

loadConfiguration

getSupportedLogLevels

setLogLevel

getLoggerConfigurations

getLoggerConfiguration

getShutdownHandler

cleanUp