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
Modifier and TypeClassDescriptionstatic final class
Description of a@ConfigurationProperties
bean.static final class
Description of an application's@ConfigurationProperties
beans.static final class
Description of an application context's@ConfigurationProperties
beans.protected static class
BeanSerializerModifier
to return only relevant configuration properties. -
Constructor Summary
ConstructorDescriptionConfigurationPropertiesReportEndpoint
(Iterable<SanitizingFunction> sanitizingFunctions, Show showValues) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
configureJsonMapper
(com.fasterxml.jackson.databind.json.JsonMapper.Builder builder) Configure Jackson'sJsonMapper
to be used to serialize the@ConfigurationProperties
objects into aMap
structure.void
setApplicationContext
(ApplicationContext context)
-
Constructor Details
-
ConfigurationPropertiesReportEndpoint
public ConfigurationPropertiesReportEndpoint(Iterable<SanitizingFunction> sanitizingFunctions, Show showValues)
-
-
Method Details
-
setApplicationContext
- Specified by:
setApplicationContext
in interfaceApplicationContextAware
- 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'sJsonMapper
to be used to serialize the@ConfigurationProperties
objects into aMap
structure.- Parameters:
builder
- the json mapper builder- Since:
- 2.6.0
-