Package 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, all property values are masked by default. To configure when property values should be shown, use management.endpoint.configprops.show-values and management.endpoint.configprops.roles 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	Description
static final class	ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptor	Description of a @ConfigurationProperties bean.
static final class	ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesDescriptor	Description of an application's @ConfigurationProperties beans.
static final class	ConfigurationPropertiesReportEndpoint.ContextConfigurationPropertiesDescriptor	Description of an application context's @ConfigurationProperties beans.
protected static class	ConfigurationPropertiesReportEndpoint.GenericSerializerModifier	BeanSerializerModifier to return only relevant configuration properties.

Constructor Summary

Constructors

Constructor	Description
ConfigurationPropertiesReportEndpoint(Iterable<SanitizingFunction> sanitizingFunctions, Show showValues)

Method Summary

Modifier and Type	Method	Description
ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesDescriptor	configurationProperties()
ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesDescriptor	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.
void	setApplicationContext(ApplicationContext context)

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationPropertiesReportEndpoint

public ConfigurationPropertiesReportEndpoint(Iterable<SanitizingFunction> sanitizingFunctions,
 Show showValues)

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext context)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

configurationProperties

@ReadOperation
public ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesDescriptor configurationProperties()

configurationPropertiesWithPrefix

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

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