org.springframework.boot.actuate.context.properties

Class ConfigurationPropertiesReportEndpoint

java.lang.Object

org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint

All Implemented Interfaces:

Aware, ApplicationContextAware

@Endpoint(id="configprops")
public class ConfigurationPropertiesReportEndpoint
extends Object
implements ApplicationContextAware

@Endpoint to expose application properties from @ConfigurationProperties annotated beans.

To protect sensitive information from being exposed, certain property values are masked if their names end with a set of configurable values (default "password" and "secret"). Configure property names by using management.endpoint.configprops.keys-to-sanitize in your Spring Boot application configuration.

Since:

2.0.0

Author:

Christian Dupuis, Dave Syer, Stephane Nicoll, Madhura Bhave, Andy Wilkinson, Chris Bono

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationPropertiesReportEndpoint.ApplicationConfigurationProperties A description of an application's @ConfigurationProperties beans.
static class	ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptor A description of a @ConfigurationProperties bean.
static class	ConfigurationPropertiesReportEndpoint.ContextConfigurationProperties A description of an application context's @ConfigurationProperties beans.
protected static class	ConfigurationPropertiesReportEndpoint.GenericSerializerModifier BeanSerializerModifier to return only relevant configuration properties.

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesReportEndpoint()
ConfigurationPropertiesReportEndpoint(Iterable<SanitizingFunction> sanitizingFunctions)

Method Summary

Modifier and Type	Method and Description
ConfigurationPropertiesReportEndpoint.ApplicationConfigurationProperties	configurationProperties()
ConfigurationPropertiesReportEndpoint.ApplicationConfigurationProperties	configurationPropertiesWithPrefix(String prefix)
protected void	configureJsonMapper(com.fasterxml.jackson.databind.json.JsonMapper.Builder builder) Configure Jackson's JsonMapper to be used to serialize the @ConfigurationProperties objects into a Map structure.
protected void	configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) Deprecated. since 2.6 for removal in 2.8 in favor of configureJsonMapper(com.fasterxml.jackson.databind.json.JsonMapper.Builder)
void	keysToSanitize(String... keysToSanitize)
void	setApplicationContext(ApplicationContext context)
void	setKeysToSanitize(String... keysToSanitize)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationPropertiesReportEndpoint

public ConfigurationPropertiesReportEndpoint()

ConfigurationPropertiesReportEndpoint

public ConfigurationPropertiesReportEndpoint(Iterable<SanitizingFunction> sanitizingFunctions)

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext context)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setKeysToSanitize

public void setKeysToSanitize(String... keysToSanitize)

keysToSanitize

public void keysToSanitize(String... keysToSanitize)

configurationProperties

@ReadOperation
public ConfigurationPropertiesReportEndpoint.ApplicationConfigurationProperties configurationProperties()

configurationPropertiesWithPrefix

@ReadOperation
public ConfigurationPropertiesReportEndpoint.ApplicationConfigurationProperties configurationPropertiesWithPrefix(@Selector
                                                                                                                                 String prefix)

configureObjectMapper

@Deprecated
protected void configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

Deprecated. since 2.6 for removal in 2.8 in favor of configureJsonMapper(com.fasterxml.jackson.databind.json.JsonMapper.Builder)

Configure Jackson's ObjectMapper to be used to serialize the @ConfigurationProperties objects into a Map structure.

Parameters:

mapper - the object mapper

configureJsonMapper

protected void configureJsonMapper(com.fasterxml.jackson.databind.json.JsonMapper.Builder builder)

Configure Jackson's JsonMapper to be used to serialize the @ConfigurationProperties objects into a Map structure.

Parameters:

builder - the json mapper builder

Since:

2.6.0