Package org.springframework.boot.logging

Class LoggingSystemProperties

java.lang.Object

org.springframework.boot.logging.LoggingSystemProperties

Direct Known Subclasses:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSOLE_LOG_CHARSET	The name of the System property that contains the console log charset.
static final String	CONSOLE_LOG_PATTERN	The name of the System property that contains the console log pattern.
static final String	EXCEPTION_CONVERSION_WORD	The name of the System property that contains the exception conversion word.
static final String	FILE_LOG_CHARSET	The name of the System property that contains the file log charset.
static final String	FILE_LOG_PATTERN	The name of the System property that contains the file log pattern.
static final String	LOG_DATEFORMAT_PATTERN	The name of the System property that contains the log date-format pattern.
static final String	LOG_FILE	The name of the System property that contains the log file.
static final String	LOG_LEVEL_PATTERN	The name of the System property that contains the log level pattern.
static final String	LOG_PATH	The name of the System property that contains the log path.
static final String	PID_KEY	The name of the System property that contains the process ID.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final void	apply()
final void	apply(LogFile logFile)
protected void	apply(LogFile logFile, PropertyResolver resolver)
protected Charset	getDefaultCharset()
protected final void	setSystemProperty(String name, String value)
protected final void	setSystemProperty(PropertyResolver resolver, String systemPropertyName, String propertyName)
protected final void	setSystemProperty(PropertyResolver resolver, String systemPropertyName, String propertyName, String defaultValue)

Methods inherited from class java.lang.Object

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

Field Details

PID_KEY

public static final String PID_KEY

The name of the System property that contains the process ID.

See Also:

• Constant Field Values

EXCEPTION_CONVERSION_WORD

public static final String EXCEPTION_CONVERSION_WORD

The name of the System property that contains the exception conversion word.

See Also:

• Constant Field Values

LOG_FILE

public static final String LOG_FILE

The name of the System property that contains the log file.

See Also:

• Constant Field Values

LOG_PATH

public static final String LOG_PATH

The name of the System property that contains the log path.

See Also:

• Constant Field Values

CONSOLE_LOG_PATTERN

public static final String CONSOLE_LOG_PATTERN

The name of the System property that contains the console log pattern.

See Also:

• Constant Field Values

CONSOLE_LOG_CHARSET

public static final String CONSOLE_LOG_CHARSET

The name of the System property that contains the console log charset.

See Also:

• Constant Field Values

FILE_LOG_PATTERN

public static final String FILE_LOG_PATTERN

The name of the System property that contains the file log pattern.

See Also:

• Constant Field Values

FILE_LOG_CHARSET

public static final String FILE_LOG_CHARSET

The name of the System property that contains the file log charset.

See Also:

• Constant Field Values

LOG_LEVEL_PATTERN

public static final String LOG_LEVEL_PATTERN

The name of the System property that contains the log level pattern.

See Also:

• Constant Field Values

LOG_DATEFORMAT_PATTERN

public static final String LOG_DATEFORMAT_PATTERN

The name of the System property that contains the log date-format pattern.

See Also:

• Constant Field Values

Constructor Details

LoggingSystemProperties

public LoggingSystemProperties(Environment environment)

Create a new LoggingSystemProperties instance.

Parameters:

environment - the source environment

LoggingSystemProperties

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

Create a new LoggingSystemProperties instance.

Parameters:

environment - the source environment

setter - setter used to apply the property

Since:

2.4.2

Method Details

getDefaultCharset

protected Charset getDefaultCharset()

apply

public final void apply()

apply

public final void apply(LogFile logFile)

apply

protected void apply(LogFile logFile,
 PropertyResolver resolver)

setSystemProperty

protected final void setSystemProperty(PropertyResolver resolver,
 String systemPropertyName,
 String propertyName)

setSystemProperty

protected final void setSystemProperty(PropertyResolver resolver,
 String systemPropertyName,
 String propertyName,
 String defaultValue)

setSystemProperty

protected final void setSystemProperty(String name,
 String value)