Class ConfigurationPropertiesReportEndpoint
- java.lang.Object
- org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint
- All Implemented Interfaces:
org.springframework.beans.factory.Aware,org.springframework.context.ApplicationContextAware
@Endpoint(id="configprops") public class ConfigurationPropertiesReportEndpoint extends Object implements org.springframework.context.ApplicationContextAware
Endpointto expose application properties fromConfigurationPropertiesannotated 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
endpoints.configprops.keys_to_sanitizein your Spring Boot application configuration.- Since:
- 2.0.0
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConfigurationPropertiesReportEndpoint.ApplicationConfigurationPropertiesA description of an application'sConfigurationPropertiesbeans.static classConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptorA description of aConfigurationPropertiesbean.static classConfigurationPropertiesReportEndpoint.ContextConfigurationPropertiesA description of an application context'sConfigurationPropertiesbeans.protected static classConfigurationPropertiesReportEndpoint.GenericSerializerModifierBeanSerializerModifierto return only relevant configuration properties.
Constructor Summary
Constructors Constructor Description ConfigurationPropertiesReportEndpoint()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConfigurationPropertiesReportEndpoint.ApplicationConfigurationPropertiesconfigurationProperties()protected voidconfigureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)Configure Jackson'sObjectMapperto be used to serialize theConfigurationPropertiesobjects into aMapstructure.voidsetApplicationContext(org.springframework.context.ApplicationContext context)voidsetKeysToSanitize(String... keysToSanitize)
Constructor Detail
ConfigurationPropertiesReportEndpoint
public ConfigurationPropertiesReportEndpoint()
Method Detail
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext context) throws org.springframework.beans.BeansException
- Specified by:
setApplicationContextin interfaceorg.springframework.context.ApplicationContextAware- Throws:
org.springframework.beans.BeansException
setKeysToSanitize
public void setKeysToSanitize(String... keysToSanitize)
configurationProperties
@ReadOperation public ConfigurationPropertiesReportEndpoint.ApplicationConfigurationProperties configurationProperties()
configureObjectMapper
protected void configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
Configure Jackson'sObjectMapperto be used to serialize theConfigurationPropertiesobjects into aMapstructure.- Parameters:
mapper- the object mapper