org.springframework.boot.DefaultPropertiesPropertySource Maven / Gradle / Ivy
/*
* Copyright 2012-2022 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;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Consumer;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.util.CollectionUtils;
/**
* {@link MapPropertySource} containing default properties contributed directly to a
* {@code SpringApplication}. By convention, the {@link DefaultPropertiesPropertySource}
* is always the last property source in the {@link Environment}.
*
* @author Phillip Webb
* @since 2.4.0
*/
public class DefaultPropertiesPropertySource extends MapPropertySource {
/**
* The name of the 'default properties' property source.
*/
public static final String NAME = "defaultProperties";
/**
* Create a new {@link DefaultPropertiesPropertySource} with the given {@code Map}
* source.
* @param source the source map
*/
public DefaultPropertiesPropertySource(Map source) {
super(NAME, source);
}
/**
* Return {@code true} if the given source is named 'defaultProperties'.
* @param propertySource the property source to check
* @return {@code true} if the name matches
*/
public static boolean hasMatchingName(PropertySource propertySource) {
return (propertySource != null) && propertySource.getName().equals(NAME);
}
/**
* Create a new {@link DefaultPropertiesPropertySource} instance if the provided
* source is not empty.
* @param source the {@code Map} source
* @param action the action used to consume the
* {@link DefaultPropertiesPropertySource}
*/
public static void ifNotEmpty(Map source, Consumer action) {
if (!CollectionUtils.isEmpty(source) && action != null) {
action.accept(new DefaultPropertiesPropertySource(source));
}
}
/**
* Add a new {@link DefaultPropertiesPropertySource} or merge with an existing one.
* @param source the {@code Map} source
* @param sources the existing sources
* @since 2.4.4
*/
public static void addOrMerge(Map source, MutablePropertySources sources) {
if (!CollectionUtils.isEmpty(source)) {
Map resultingSource = new HashMap<>();
DefaultPropertiesPropertySource propertySource = new DefaultPropertiesPropertySource(resultingSource);
if (sources.contains(NAME)) {
mergeIfPossible(source, sources, resultingSource);
sources.replace(NAME, propertySource);
}
else {
resultingSource.putAll(source);
sources.addLast(propertySource);
}
}
}
@SuppressWarnings("unchecked")
private static void mergeIfPossible(Map source, MutablePropertySources sources,
Map resultingSource) {
PropertySource existingSource = sources.get(NAME);
if (existingSource != null) {
Object underlyingSource = existingSource.getSource();
if (underlyingSource instanceof Map) {
resultingSource.putAll((Map) underlyingSource);
}
resultingSource.putAll(source);
}
}
/**
* Move the 'defaultProperties' property source so that it's the last source in the
* given {@link ConfigurableEnvironment}.
* @param environment the environment to update
*/
public static void moveToEnd(ConfigurableEnvironment environment) {
moveToEnd(environment.getPropertySources());
}
/**
* Move the 'defaultProperties' property source so that it's the last source in the
* given {@link MutablePropertySources}.
* @param propertySources the property sources to update
*/
public static void moveToEnd(MutablePropertySources propertySources) {
PropertySource propertySource = propertySources.remove(NAME);
if (propertySource != null) {
propertySources.addLast(propertySource);
}
}
}