Class LoggingSystemProperties

java.lang.Object

org.springframework.boot.logging.LoggingSystemProperties

Direct Known Subclasses:

Log4j2LoggingSystemProperties, LogbackLoggingSystemProperties

public class LoggingSystemProperties
extends Object

Utility to set system properties that can later be used by log configuration files.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb, Madhura Bhave, Vedran Pavic, Robert Thornton, Eddú Meléndez, Jonatan Ivanov

See Also:

• LoggingSystemProperty

Constructor Summary

Constructors

Constructor	Description
LoggingSystemProperties(Environment environment)	Create a new LoggingSystemProperties instance.
LoggingSystemProperties(Environment environment, @Nullable BiConsumer<String, @Nullable String> setter)	Create a new LoggingSystemProperties instance.
LoggingSystemProperties(Environment environment, @Nullable Function<@Nullable String, @Nullable String> defaultValueResolver, @Nullable BiConsumer<String, @Nullable String> setter)	Create a new LoggingSystemProperties instance.

Method Summary

Modifier and Type	Method	Description
final void	apply()
final void	apply(@Nullable LogFile logFile)
protected void	apply(@Nullable LogFile logFile, PropertyResolver resolver)
protected @Nullable Console	getConsole()	Returns the Console to use.
protected Charset	getDefaultConsoleCharset()	Returns the default console charset.
protected Charset	getDefaultFileCharset()	Returns the default file charset.
protected final void	setSystemProperty(String name, @Nullable String value)	Set a system property.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LoggingSystemProperties

public LoggingSystemProperties(Environment environment)

Create a new LoggingSystemProperties instance.

Parameters:

environment - the source environment

LoggingSystemProperties

public LoggingSystemProperties(Environment environment,
 @Nullable BiConsumer<String, @Nullable String> setter)

Create a new LoggingSystemProperties instance.

Parameters:

environment - the source environment

setter - setter used to apply the property or null for system properties

Since:

2.4.2

LoggingSystemProperties

public LoggingSystemProperties(Environment environment,
 @Nullable Function<@Nullable String, @Nullable String> defaultValueResolver,
 @Nullable BiConsumer<String, @Nullable String> setter)

Create a new LoggingSystemProperties instance.

Parameters:

environment - the source environment

defaultValueResolver - function used to resolve default values or null

setter - setter used to apply the property or null for system properties

Since:

3.2.0

Method Details

getConsole

protected @Nullable Console getConsole()

Returns the Console to use.

Returns:

the Console to use

Since:

3.5.0

apply

public final void apply()

apply

public final void apply(@Nullable LogFile logFile)

apply

protected void apply(@Nullable LogFile logFile,
 PropertyResolver resolver)

getDefaultConsoleCharset

protected Charset getDefaultConsoleCharset()

Returns the default console charset.

Returns:

the default console charset

Since:

3.5.0

getDefaultFileCharset

protected Charset getDefaultFileCharset()

Returns the default file charset.

Returns:

the default file charset

Since:

3.5.0

setSystemProperty

protected final void setSystemProperty(String name,
 @Nullable String value)

Set a system property.

Parameters:

name - the property name

value - the value