LogbackLoggingSystemProperties (spring-boot 3.3.5)

java.lang.Object

org.springframework.boot.logging.LoggingSystemProperties

org.springframework.boot.logging.logback.LogbackLoggingSystemProperties

public class LogbackLoggingSystemProperties extends LoggingSystemProperties

LoggingSystemProperties for Logback.

Since:

2.4.0

See Also:

RollingPolicySystemProperty

Field Summary

Fields

Modifier and Type

Field

Description

static final String

ROLLINGPOLICY_CLEAN_HISTORY_ON_START

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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.CLEAN_HISTORY_ON_START

static final String

ROLLINGPOLICY_FILE_NAME_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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.FILE_NAME_PATTERN

static final String

ROLLINGPOLICY_MAX_FILE_SIZE

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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.MAX_FILE_SIZE

static final String

ROLLINGPOLICY_MAX_HISTORY

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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.MAX_HISTORY

static final String

ROLLINGPOLICY_TOTAL_SIZE_CAP

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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.TOTAL_SIZE_CAP

Fields inherited from class org.springframework.boot.logging.LoggingSystemProperties
CONSOLE_LOG_CHARSET, CONSOLE_LOG_PATTERN, CONSOLE_LOG_THRESHOLD, EXCEPTION_CONVERSION_WORD, FILE_LOG_CHARSET, FILE_LOG_PATTERN, FILE_LOG_THRESHOLD, LOG_DATEFORMAT_PATTERN, LOG_FILE, LOG_LEVEL_PATTERN, LOG_PATH, PID_KEY
Constructor Summary

Constructors

Constructor

Description

LogbackLoggingSystemProperties(org.springframework.core.env.Environment environment)

LogbackLoggingSystemProperties(org.springframework.core.env.Environment environment, BiConsumer<String,String> setter)

Create a new LogbackLoggingSystemProperties instance.

LogbackLoggingSystemProperties(org.springframework.core.env.Environment environment, Function<String,String> defaultValueResolver, BiConsumer<String,String> setter)

Create a new LoggingSystemProperties instance.
Method Summary

Modifier and Type

Method

Description

protected void

apply(LogFile logFile, org.springframework.core.env.PropertyResolver resolver)

protected Charset

getDefaultCharset()

Methods inherited from class org.springframework.boot.logging.LoggingSystemProperties
apply, apply, setSystemProperty, setSystemProperty, setSystemProperty

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

Field Details
- ROLLINGPOLICY_FILE_NAME_PATTERN
  
  @Deprecated(since="3.2.0", forRemoval=true) public static final String ROLLINGPOLICY_FILE_NAME_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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.FILE_NAME_PATTERN
  
  The name of the System property that contains the rolled-over log file name pattern.
- ROLLINGPOLICY_CLEAN_HISTORY_ON_START
  
  @Deprecated(since="3.2.0", forRemoval=true) public static final String ROLLINGPOLICY_CLEAN_HISTORY_ON_START
  
  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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.CLEAN_HISTORY_ON_START
  
  The name of the System property that contains the clean history on start flag.
- ROLLINGPOLICY_MAX_FILE_SIZE
  
  @Deprecated(since="3.2.0", forRemoval=true) public static final String ROLLINGPOLICY_MAX_FILE_SIZE
  
  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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.MAX_FILE_SIZE
  
  The name of the System property that contains the file log max size.
- ROLLINGPOLICY_TOTAL_SIZE_CAP
  
  @Deprecated(since="3.2.0", forRemoval=true) public static final String ROLLINGPOLICY_TOTAL_SIZE_CAP
  
  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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.TOTAL_SIZE_CAP
  
  The name of the System property that contains the file total size cap.
- ROLLINGPOLICY_MAX_HISTORY
  
  @Deprecated(since="3.2.0", forRemoval=true) public static final String ROLLINGPOLICY_MAX_HISTORY
  
  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 RollingPolicySystemProperty.getEnvironmentVariableName() on RollingPolicySystemProperty.MAX_HISTORY
  
  The name of the System property that contains the file log max history.
Constructor Details
- LogbackLoggingSystemProperties
  
  public LogbackLoggingSystemProperties(org.springframework.core.env.Environment environment)
- LogbackLoggingSystemProperties
  
  public LogbackLoggingSystemProperties(org.springframework.core.env.Environment environment, BiConsumer<String,String> setter)
  
  Create a new LogbackLoggingSystemProperties instance.
  
  Parameters:
  
  environment - the source environment
  
  setter - setter used to apply the property
  
  Since:
  
  2.4.3
- LogbackLoggingSystemProperties
  
  public LogbackLoggingSystemProperties(org.springframework.core.env.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()
  
  Overrides:
  
  getDefaultCharset in class LoggingSystemProperties
- apply
  
  protected void apply(LogFile logFile, org.springframework.core.env.PropertyResolver resolver)
  
  Overrides:
  
  apply in class LoggingSystemProperties

Class LogbackLoggingSystemProperties

Field Summary

Fields inherited from class org.springframework.boot.logging.LoggingSystemProperties

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

ROLLINGPOLICY_FILE_NAME_PATTERN

ROLLINGPOLICY_CLEAN_HISTORY_ON_START

ROLLINGPOLICY_MAX_FILE_SIZE

ROLLINGPOLICY_TOTAL_SIZE_CAP

ROLLINGPOLICY_MAX_HISTORY

Constructor Details

LogbackLoggingSystemProperties

LogbackLoggingSystemProperties

LogbackLoggingSystemProperties

Method Details

getDefaultCharset

apply