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.
org.springframework.boot.actuate.env.EnvironmentEndpoint Maven / Gradle / Ivy
/*
* Copyright 2012-2018 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.actuate.env;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Predicate;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import com.fasterxml.jackson.annotation.JsonInclude;
import org.springframework.boot.actuate.endpoint.Sanitizer;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.Selector;
import org.springframework.boot.context.properties.bind.PlaceholdersResolver;
import org.springframework.boot.context.properties.bind.PropertySourcesPlaceholdersResolver;
import org.springframework.boot.context.properties.source.ConfigurationPropertySources;
import org.springframework.boot.origin.Origin;
import org.springframework.boot.origin.OriginLookup;
import org.springframework.core.env.CompositePropertySource;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.EnumerablePropertySource;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.lang.Nullable;
import org.springframework.util.PropertyPlaceholderHelper;
import org.springframework.util.StringUtils;
import org.springframework.util.SystemPropertyUtils;
/**
* {@link Endpoint} to expose {@link ConfigurableEnvironment environment} information.
*
* @author Dave Syer
* @author Phillip Webb
* @author Christian Dupuis
* @author Madhura Bhave
* @author Stephane Nicoll
* @since 2.0.0
*/
@Endpoint(id = "env")
public class EnvironmentEndpoint {
private final Sanitizer sanitizer = new Sanitizer();
private final Environment environment;
public EnvironmentEndpoint(Environment environment) {
this.environment = environment;
}
public void setKeysToSanitize(String... keysToSanitize) {
this.sanitizer.setKeysToSanitize(keysToSanitize);
}
@ReadOperation
public EnvironmentDescriptor environment(@Nullable String pattern) {
if (StringUtils.hasText(pattern)) {
return getEnvironmentDescriptor(Pattern.compile(pattern).asPredicate());
}
return getEnvironmentDescriptor((name) -> true);
}
@ReadOperation
public EnvironmentEntryDescriptor environmentEntry(@Selector String toMatch) {
return getEnvironmentEntryDescriptor(toMatch);
}
private EnvironmentDescriptor getEnvironmentDescriptor(
Predicate propertyNamePredicate) {
PlaceholdersResolver resolver = getResolver();
List propertySources = new ArrayList<>();
getPropertySourcesAsMap().forEach((sourceName, source) -> {
if (source instanceof EnumerablePropertySource) {
propertySources.add(
describeSource(sourceName, (EnumerablePropertySource) source,
resolver, propertyNamePredicate));
}
});
return new EnvironmentDescriptor(
Arrays.asList(this.environment.getActiveProfiles()), propertySources);
}
private EnvironmentEntryDescriptor getEnvironmentEntryDescriptor(
String propertyName) {
Map descriptors = getPropertySourceDescriptors(
propertyName);
PropertySummaryDescriptor summary = getPropertySummaryDescriptor(descriptors);
return new EnvironmentEntryDescriptor(summary,
Arrays.asList(this.environment.getActiveProfiles()),
toPropertySourceDescriptors(descriptors));
}
private List toPropertySourceDescriptors(
Map descriptors) {
List result = new ArrayList<>();
descriptors.forEach((name, property) -> result
.add(new PropertySourceEntryDescriptor(name, property)));
return result;
}
private PropertySummaryDescriptor getPropertySummaryDescriptor(
Map descriptors) {
for (Map.Entry entry : descriptors.entrySet()) {
if (entry.getValue() != null) {
return new PropertySummaryDescriptor(entry.getKey(),
entry.getValue().getValue());
}
}
return null;
}
private Map getPropertySourceDescriptors(
String propertyName) {
Map propertySources = new LinkedHashMap<>();
PlaceholdersResolver resolver = getResolver();
getPropertySourcesAsMap().forEach((sourceName, source) -> propertySources
.put(sourceName, source.containsProperty(propertyName)
? describeValueOf(propertyName, source, resolver) : null));
return propertySources;
}
private PropertySourceDescriptor describeSource(String sourceName,
EnumerablePropertySource source, PlaceholdersResolver resolver,
Predicate namePredicate) {
Map properties = new LinkedHashMap<>();
Stream.of(source.getPropertyNames()).filter(namePredicate).forEach(
(name) -> properties.put(name, describeValueOf(name, source, resolver)));
return new PropertySourceDescriptor(sourceName, properties);
}
@SuppressWarnings("unchecked")
private PropertyValueDescriptor describeValueOf(String name, PropertySource source,
PlaceholdersResolver resolver) {
Object resolved = resolver.resolvePlaceholders(source.getProperty(name));
String origin = ((source instanceof OriginLookup)
? getOrigin((OriginLookup) source, name) : null);
return new PropertyValueDescriptor(sanitize(name, resolved), origin);
}
private String getOrigin(OriginLookup lookup, String name) {
Origin origin = lookup.getOrigin(name);
return (origin != null) ? origin.toString() : null;
}
private PlaceholdersResolver getResolver() {
return new PropertySourcesPlaceholdersSanitizingResolver(getPropertySources(),
this.sanitizer);
}
private Map> getPropertySourcesAsMap() {
Map> map = new LinkedHashMap<>();
for (PropertySource source : getPropertySources()) {
if (!ConfigurationPropertySources
.isAttachedConfigurationPropertySource(source)) {
extract("", map, source);
}
}
return map;
}
private MutablePropertySources getPropertySources() {
if (this.environment instanceof ConfigurableEnvironment) {
return ((ConfigurableEnvironment) this.environment).getPropertySources();
}
return new StandardEnvironment().getPropertySources();
}
private void extract(String root, Map> map,
PropertySource source) {
if (source instanceof CompositePropertySource) {
for (PropertySource nest : ((CompositePropertySource) source)
.getPropertySources()) {
extract(source.getName() + ":", map, nest);
}
}
else {
map.put(root + source.getName(), source);
}
}
public Object sanitize(String name, Object object) {
return this.sanitizer.sanitize(name, object);
}
/**
* {@link PropertySourcesPlaceholdersResolver} that sanitizes sensitive placeholders
* if present.
*/
private static class PropertySourcesPlaceholdersSanitizingResolver
extends PropertySourcesPlaceholdersResolver {
private final Sanitizer sanitizer;
PropertySourcesPlaceholdersSanitizingResolver(Iterable> sources,
Sanitizer sanitizer) {
super(sources,
new PropertyPlaceholderHelper(SystemPropertyUtils.PLACEHOLDER_PREFIX,
SystemPropertyUtils.PLACEHOLDER_SUFFIX,
SystemPropertyUtils.VALUE_SEPARATOR, true));
this.sanitizer = sanitizer;
}
@Override
protected String resolvePlaceholder(String placeholder) {
String value = super.resolvePlaceholder(placeholder);
if (value == null) {
return null;
}
return (String) this.sanitizer.sanitize(placeholder, value);
}
}
/**
* A description of an {@link Environment}.
*/
public static final class EnvironmentDescriptor {
private final List activeProfiles;
private final List propertySources;
private EnvironmentDescriptor(List activeProfiles,
List propertySources) {
this.activeProfiles = activeProfiles;
this.propertySources = propertySources;
}
public List getActiveProfiles() {
return this.activeProfiles;
}
public List getPropertySources() {
return this.propertySources;
}
}
/**
* A description of an entry of the {@link Environment}.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public static final class EnvironmentEntryDescriptor {
private final PropertySummaryDescriptor property;
private final List activeProfiles;
private final List propertySources;
private EnvironmentEntryDescriptor(PropertySummaryDescriptor property,
List activeProfiles,
List propertySources) {
this.property = property;
this.activeProfiles = activeProfiles;
this.propertySources = propertySources;
}
public PropertySummaryDescriptor getProperty() {
return this.property;
}
public List getActiveProfiles() {
return this.activeProfiles;
}
public List getPropertySources() {
return this.propertySources;
}
}
/**
* A summary of a particular entry of the {@link Environment}.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public static final class PropertySummaryDescriptor {
private final String source;
private final Object value;
public PropertySummaryDescriptor(String source, Object value) {
this.source = source;
this.value = value;
}
public String getSource() {
return this.source;
}
public Object getValue() {
return this.value;
}
}
/**
* A description of a {@link PropertySource}.
*/
public static final class PropertySourceDescriptor {
private final String name;
private final Map properties;
private PropertySourceDescriptor(String name,
Map properties) {
this.name = name;
this.properties = properties;
}
public String getName() {
return this.name;
}
public Map getProperties() {
return this.properties;
}
}
/**
* A description of a particular entry of {@link PropertySource}.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public static final class PropertySourceEntryDescriptor {
private final String name;
private final PropertyValueDescriptor property;
private PropertySourceEntryDescriptor(String name,
PropertyValueDescriptor property) {
this.name = name;
this.property = property;
}
public String getName() {
return this.name;
}
public PropertyValueDescriptor getProperty() {
return this.property;
}
}
/**
* A description of a property's value, including its origin if available.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public static final class PropertyValueDescriptor {
private final Object value;
private final String origin;
private PropertyValueDescriptor(Object value, String origin) {
this.value = value;
this.origin = origin;
}
public Object getValue() {
return this.value;
}
public String getOrigin() {
return this.origin;
}
}
}
