LoggingSystemProperties (Spring Boot 2.4.4 API)

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 and Description
`static String`	`CONSOLE_LOG_CHARSET` The name of the System property that contains the console log charset.
`static String`	`CONSOLE_LOG_PATTERN` The name of the System property that contains the console log pattern.
`static String`	`EXCEPTION_CONVERSION_WORD` The name of the System property that contains the exception conversion word.
`static String`	`FILE_CLEAN_HISTORY_ON_START` Deprecated. since 2.4.0 in favor of `LogbackLoggingSystemProperties.ROLLINGPOLICY_CLEAN_HISTORY_ON_START`
`static String`	`FILE_LOG_CHARSET` The name of the System property that contains the file log charset.
`static String`	`FILE_LOG_PATTERN` The name of the System property that contains the file log pattern.
`static String`	`FILE_MAX_HISTORY` Deprecated. since 2.4.0 in favor of `LogbackLoggingSystemProperties.ROLLINGPOLICY_MAX_HISTORY`
`static String`	`FILE_MAX_SIZE` Deprecated. since 2.4.0 in favor of `LogbackLoggingSystemProperties.ROLLINGPOLICY_MAX_FILE_SIZE`
`static String`	`FILE_TOTAL_SIZE_CAP` Deprecated. since 2.4.0 in favor of `LogbackLoggingSystemProperties.ROLLINGPOLICY_TOTAL_SIZE_CAP`
`static String`	`LOG_DATEFORMAT_PATTERN` The name of the System property that contains the log date-format pattern.
`static String`	`LOG_FILE` The name of the System property that contains the log file.
`static String`	`LOG_LEVEL_PATTERN` The name of the System property that contains the log level pattern.
`static String`	`LOG_PATH` The name of the System property that contains the log path.
`static String`	`PID_KEY` The name of the System property that contains the process ID.
`static String`	`ROLLING_FILE_NAME_PATTERN` Deprecated. since 2.4.0 in favor of `LogbackLoggingSystemProperties.ROLLINGPOLICY_FILE_NAME_PATTERN`

Constructor Summary

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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
  - ROLLING_FILE_NAME_PATTERN
```
@Deprecated
public static final String ROLLING_FILE_NAME_PATTERN
```
    Deprecated. since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_FILE_NAME_PATTERN
    
    The name of the System property that contains the rolled-over log file name pattern.
    
    See Also:
    
    Constant Field Values
  - FILE_CLEAN_HISTORY_ON_START
```
@Deprecated
public static final String FILE_CLEAN_HISTORY_ON_START
```
    Deprecated. since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_CLEAN_HISTORY_ON_START
    
    The name of the System property that contains the clean history on start flag.
    
    See Also:
    
    Constant Field Values
  - FILE_MAX_SIZE
```
@Deprecated
public static final String FILE_MAX_SIZE
```
    Deprecated. since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_MAX_FILE_SIZE
    
    The name of the System property that contains the file log max size.
    
    See Also:
    
    Constant Field Values
  - FILE_TOTAL_SIZE_CAP
```
@Deprecated
public static final String FILE_TOTAL_SIZE_CAP
```
    Deprecated. since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_TOTAL_SIZE_CAP
    
    The name of the System property that contains the file total size cap.
    
    See Also:
    
    Constant Field Values
  - FILE_MAX_HISTORY
```
@Deprecated
public static final String FILE_MAX_HISTORY
```
    Deprecated. since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_MAX_HISTORY
    
    The name of the System property that contains the file log max history.
    
    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 Detail
  - 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 Detail
  - 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)
```

Class LoggingSystemProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PID_KEY

EXCEPTION_CONVERSION_WORD

LOG_FILE

LOG_PATH

CONSOLE_LOG_PATTERN

CONSOLE_LOG_CHARSET

FILE_LOG_PATTERN

FILE_LOG_CHARSET

ROLLING_FILE_NAME_PATTERN

FILE_CLEAN_HISTORY_ON_START

FILE_MAX_SIZE

FILE_TOTAL_SIZE_CAP

FILE_MAX_HISTORY

LOG_LEVEL_PATTERN

LOG_DATEFORMAT_PATTERN

Constructor Detail

LoggingSystemProperties

LoggingSystemProperties

Method Detail

getDefaultCharset

apply

apply

apply

setSystemProperty

setSystemProperty

setSystemProperty