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, Jonatan Ivanov

See Also:

• LoggingSystemProperty

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSOLE_LOG_CHARSET	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.CONSOLE_CHARSET
static final String	CONSOLE_LOG_PATTERN	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.CONSOLE_PATTERN
static final String	CONSOLE_LOG_THRESHOLD	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.CONSOLE_THRESHOLD
static final String	EXCEPTION_CONVERSION_WORD	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.EXCEPTION_CONVERSION_WORD
static final String	FILE_LOG_CHARSET	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.FILE_CHARSET
static final String	FILE_LOG_PATTERN	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.FILE_PATTERN
static final String	FILE_LOG_THRESHOLD	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.FILE_THRESHOLD
static final String	LOG_DATEFORMAT_PATTERN	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.DATEFORMAT_PATTERN
static final String	LOG_FILE	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.LOG_FILE
static final String	LOG_LEVEL_PATTERN	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.LEVEL_PATTERN
static final String	LOG_PATH	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.LOG_PATH
static final String	PID_KEY	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.PID

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.
LoggingSystemProperties(Environment environment, Function<String,String> defaultValueResolver, 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)	Set a system property.
protected final void	setSystemProperty(PropertyResolver resolver, String systemPropertyName, String propertyName)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 with no replacement
protected final void	setSystemProperty(PropertyResolver resolver, String systemPropertyName, String propertyName, String defaultValue)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 with no replacement

Methods inherited from class java.lang.Object

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

Field Details

PID_KEY

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String PID_KEY

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.PID

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

EXCEPTION_CONVERSION_WORD

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String EXCEPTION_CONVERSION_WORD

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.EXCEPTION_CONVERSION_WORD

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

LOG_FILE

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String LOG_FILE

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.LOG_FILE

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

LOG_PATH

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String LOG_PATH

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.LOG_PATH

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

CONSOLE_LOG_PATTERN

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String CONSOLE_LOG_PATTERN

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.CONSOLE_PATTERN

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

CONSOLE_LOG_CHARSET

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String CONSOLE_LOG_CHARSET

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.CONSOLE_CHARSET

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

CONSOLE_LOG_THRESHOLD

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String CONSOLE_LOG_THRESHOLD

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.CONSOLE_THRESHOLD

The log level threshold for console log.

FILE_LOG_PATTERN

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String FILE_LOG_PATTERN

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.FILE_PATTERN

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

FILE_LOG_CHARSET

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String FILE_LOG_CHARSET

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.FILE_CHARSET

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

FILE_LOG_THRESHOLD

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String FILE_LOG_THRESHOLD

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.FILE_THRESHOLD

The log level threshold for file log.

LOG_LEVEL_PATTERN

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String LOG_LEVEL_PATTERN

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.LEVEL_PATTERN

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

LOG_DATEFORMAT_PATTERN

@Deprecated(since="3.2.0",
            forRemoval=true)
public static final String LOG_DATEFORMAT_PATTERN

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of calling LoggingSystemProperty.getEnvironmentVariableName() on LoggingSystemProperty.DATEFORMAT_PATTERN

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

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 or null for system properties

Since:

2.4.2

LoggingSystemProperties

public LoggingSystemProperties(Environment environment,
 Function<String,String> defaultValueResolver,
 BiConsumer<String,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

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

@Deprecated(since="3.2.0",
            forRemoval=true)
protected final void setSystemProperty(PropertyResolver resolver,
 String systemPropertyName,
 String propertyName)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 with no replacement

Set a system property.

Parameters:

resolver - the resolver used to get the property value

systemPropertyName - the system property name

propertyName - the application property name

setSystemProperty

@Deprecated(since="3.2.0",
            forRemoval=true)
protected final void setSystemProperty(PropertyResolver resolver,
 String systemPropertyName,
 String propertyName,
 String defaultValue)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 with no replacement

Set a system property.

Parameters:

resolver - the resolver used to get the property value

systemPropertyName - the system property name

propertyName - the application property name

defaultValue - the default value if none can be resolved

setSystemProperty

protected final void setSystemProperty(String name,
 String value)

Set a system property.

Parameters:

name - the property name

value - the value