Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.logging;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.function.BiConsumer;
import java.util.function.Function;
import org.springframework.boot.system.ApplicationPid;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertyResolver;
import org.springframework.core.env.PropertySourcesPropertyResolver;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* Utility to set system properties that can later be used by log configuration files.
*
* @author Andy Wilkinson
* @author Phillip Webb
* @author Madhura Bhave
* @author Vedran Pavic
* @author Robert Thornton
* @author Eddú Meléndez
* @author Jonatan Ivanov
* @since 2.0.0
* @see LoggingSystemProperty
*/
public class LoggingSystemProperties {
/**
* The name of the System property that contains the process ID.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#PID}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String PID_KEY = LoggingSystemProperty.PID.getEnvironmentVariableName();
/**
* The name of the System property that contains the exception conversion word.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#EXCEPTION_CONVERSION_WORD}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String EXCEPTION_CONVERSION_WORD = LoggingSystemProperty.EXCEPTION_CONVERSION_WORD
.getEnvironmentVariableName();
/**
* The name of the System property that contains the log file.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#LOG_FILE}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String LOG_FILE = LoggingSystemProperty.LOG_FILE.getEnvironmentVariableName();
/**
* The name of the System property that contains the log path.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#LOG_PATH}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String LOG_PATH = LoggingSystemProperty.LOG_PATH.getEnvironmentVariableName();
/**
* The name of the System property that contains the console log pattern.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#CONSOLE_PATTERN}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String CONSOLE_LOG_PATTERN = LoggingSystemProperty.CONSOLE_PATTERN.getEnvironmentVariableName();
/**
* The name of the System property that contains the console log charset.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#CONSOLE_CHARSET}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String CONSOLE_LOG_CHARSET = LoggingSystemProperty.CONSOLE_CHARSET.getEnvironmentVariableName();
/**
* The log level threshold for console log.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#CONSOLE_THRESHOLD}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String CONSOLE_LOG_THRESHOLD = LoggingSystemProperty.CONSOLE_THRESHOLD
.getEnvironmentVariableName();
/**
* The name of the System property that contains the file log pattern.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#FILE_PATTERN}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String FILE_LOG_PATTERN = LoggingSystemProperty.FILE_PATTERN.getEnvironmentVariableName();
/**
* The name of the System property that contains the file log charset.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#FILE_CHARSET}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String FILE_LOG_CHARSET = LoggingSystemProperty.FILE_CHARSET.getEnvironmentVariableName();
/**
* The log level threshold for file log.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#FILE_THRESHOLD}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String FILE_LOG_THRESHOLD = LoggingSystemProperty.FILE_THRESHOLD.getEnvironmentVariableName();
/**
* The name of the System property that contains the log level pattern.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#LEVEL_PATTERN}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String LOG_LEVEL_PATTERN = LoggingSystemProperty.LEVEL_PATTERN.getEnvironmentVariableName();
/**
* The name of the System property that contains the log date-format pattern.
* @deprecated since 3.2.0 for removal in 3.4.0 in favor of calling
* {@link LoggingSystemProperty#getEnvironmentVariableName()} on
* {@link LoggingSystemProperty#DATEFORMAT_PATTERN}
*/
@Deprecated(since = "3.2.0", forRemoval = true)
public static final String LOG_DATEFORMAT_PATTERN = LoggingSystemProperty.DATEFORMAT_PATTERN
.getEnvironmentVariableName();
private static final BiConsumer systemPropertySetter = (name, value) -> {
if (System.getProperty(name) == null && value != null) {
System.setProperty(name, value);
}
};
private final Environment environment;
private final Function defaultValueResolver;
private final BiConsumer setter;
/**
* Create a new {@link LoggingSystemProperties} instance.
* @param environment the source environment
*/
public LoggingSystemProperties(Environment environment) {
this(environment, null);
}
/**
* Create a new {@link LoggingSystemProperties} instance.
* @param environment the source environment
* @param setter setter used to apply the property or {@code null} for system
* properties
* @since 2.4.2
*/
public LoggingSystemProperties(Environment environment, BiConsumer setter) {
this(environment, null, setter);
}
/**
* Create a new {@link LoggingSystemProperties} instance.
* @param environment the source environment
* @param defaultValueResolver function used to resolve default values or {@code null}
* @param setter setter used to apply the property or {@code null} for system
* properties
* @since 3.2.0
*/
public LoggingSystemProperties(Environment environment, Function defaultValueResolver,
BiConsumer setter) {
Assert.notNull(environment, "Environment must not be null");
this.environment = environment;
this.defaultValueResolver = (defaultValueResolver != null) ? defaultValueResolver : (name) -> null;
this.setter = (setter != null) ? setter : systemPropertySetter;
}
protected Charset getDefaultCharset() {
return StandardCharsets.UTF_8;
}
public final void apply() {
apply(null);
}
public final void apply(LogFile logFile) {
PropertyResolver resolver = getPropertyResolver();
apply(logFile, resolver);
}
private PropertyResolver getPropertyResolver() {
if (this.environment instanceof ConfigurableEnvironment configurableEnvironment) {
PropertySourcesPropertyResolver resolver = new PropertySourcesPropertyResolver(
configurableEnvironment.getPropertySources());
resolver.setConversionService(((ConfigurableEnvironment) this.environment).getConversionService());
resolver.setIgnoreUnresolvableNestedPlaceholders(true);
return resolver;
}
return this.environment;
}
protected void apply(LogFile logFile, PropertyResolver resolver) {
String defaultCharsetName = getDefaultCharset().name();
setApplicationNameSystemProperty(resolver);
setSystemProperty(LoggingSystemProperty.PID, new ApplicationPid().toString());
setSystemProperty(LoggingSystemProperty.CONSOLE_CHARSET, resolver, defaultCharsetName);
setSystemProperty(LoggingSystemProperty.FILE_CHARSET, resolver, defaultCharsetName);
setSystemProperty(LoggingSystemProperty.CONSOLE_THRESHOLD, resolver);
setSystemProperty(LoggingSystemProperty.FILE_THRESHOLD, resolver);
setSystemProperty(LoggingSystemProperty.EXCEPTION_CONVERSION_WORD, resolver);
setSystemProperty(LoggingSystemProperty.CONSOLE_PATTERN, resolver);
setSystemProperty(LoggingSystemProperty.FILE_PATTERN, resolver);
setSystemProperty(LoggingSystemProperty.LEVEL_PATTERN, resolver);
setSystemProperty(LoggingSystemProperty.DATEFORMAT_PATTERN, resolver);
setSystemProperty(LoggingSystemProperty.CORRELATION_PATTERN, resolver);
if (logFile != null) {
logFile.applyToSystemProperties();
}
}
private void setApplicationNameSystemProperty(PropertyResolver resolver) {
if (resolver.getProperty("logging.include-application-name", Boolean.class, Boolean.TRUE)) {
String applicationName = resolver.getProperty("spring.application.name");
if (StringUtils.hasText(applicationName)) {
setSystemProperty(LoggingSystemProperty.APPLICATION_NAME.getEnvironmentVariableName(),
"[%s] ".formatted(applicationName));
}
}
}
private void setSystemProperty(LoggingSystemProperty property, PropertyResolver resolver) {
setSystemProperty(property, resolver, null);
}
private void setSystemProperty(LoggingSystemProperty property, PropertyResolver resolver, String defaultValue) {
String value = (property.getApplicationPropertyName() != null)
? resolver.getProperty(property.getApplicationPropertyName()) : null;
value = (value != null) ? value : this.defaultValueResolver.apply(property.getApplicationPropertyName());
value = (value != null) ? value : defaultValue;
setSystemProperty(property.getEnvironmentVariableName(), value);
}
private void setSystemProperty(LoggingSystemProperty property, String value) {
setSystemProperty(property.getEnvironmentVariableName(), value);
}
/**
* Set a system property.
* @param resolver the resolver used to get the property value
* @param systemPropertyName the system property name
* @param propertyName the application property name
* @deprecated since 3.2.0 for removal in 3.4.0 with no replacement
*/
@Deprecated(since = "3.2.0", forRemoval = true)
protected final void setSystemProperty(PropertyResolver resolver, String systemPropertyName, String propertyName) {
setSystemProperty(resolver, systemPropertyName, propertyName, null);
}
/**
* Set a system property.
* @param resolver the resolver used to get the property value
* @param systemPropertyName the system property name
* @param propertyName the application property name
* @param defaultValue the default value if none can be resolved
* @deprecated since 3.2.0 for removal in 3.4.0 with no replacement
*/
@Deprecated(since = "3.2.0", forRemoval = true)
protected final void setSystemProperty(PropertyResolver resolver, String systemPropertyName, String propertyName,
String defaultValue) {
String value = resolver.getProperty(propertyName);
value = (value != null) ? value : this.defaultValueResolver.apply(systemPropertyName);
value = (value != null) ? value : defaultValue;
setSystemProperty(systemPropertyName, value);
}
/**
* Set a system property.
* @param name the property name
* @param value the value
*/
protected final void setSystemProperty(String name, String value) {
this.setter.accept(name, value);
}
}
