org.springframework.boot.actuate.endpoint

Class ConfigurationPropertiesReportEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.AbstractEndpoint<Map<String,Object>>

org.springframework.boot.actuate.endpoint.ConfigurationPropertiesReportEndpoint

All Implemented Interfaces:

Aware, Endpoint<Map<String,Object>>, ApplicationContextAware, EnvironmentAware

@ConfigurationProperties(prefix="endpoints.configprops",
                         ignoreUnknownFields=false)
public class ConfigurationPropertiesReportEndpoint
extends AbstractEndpoint<Map<String,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 endpoints.configprops.keys_to_sanitize in your Spring Boot application configuration.

Author:

Christian Dupuis, Dave Syer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesMetaData Convenience class for grabbing and caching valid property names from /META-INF/spring-configuration-metadata.json so that metadata that is known to be valid can be used to pull the correct nested properties out of beans that might otherwise be tricky (contain cycles or other unserializable properties).
protected static class	ConfigurationPropertiesReportEndpoint.GenericSerializerModifier BeanSerializerModifier to return only relevant configuration properties.

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesReportEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) Configure Jackson's ObjectMapper to be used to serialize the ConfigurationProperties objects into a Map structure.
protected Map<String,Object>	extract(ApplicationContext context) Extract beans annotated ConfigurationProperties and serialize into Map.
Map<String,Object>	invoke() Called to invoke the endpoint.
void	setApplicationContext(ApplicationContext context)
void	setKeysToSanitize(String... keysToSanitize)
void	setMetadataLocations(String metadataLocations) Location path for JSON metadata about config properties.

Methods inherited from class org.springframework.boot.actuate.endpoint.AbstractEndpoint

getId, isEnabled, isSensitive, setEnabled, setEnvironment, setId, setSensitive

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPropertiesReportEndpoint

public ConfigurationPropertiesReportEndpoint()

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext context)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setKeysToSanitize

public void setKeysToSanitize(String... keysToSanitize)

setMetadataLocations

public void setMetadataLocations(String metadataLocations)

Location path for JSON metadata about config properties.

Parameters:

metadataLocations - the metadataLocations to set

invoke

public Map<String,Object> invoke()

Description copied from interface: Endpoint

Called to invoke the endpoint.

Specified by:

invoke in interface Endpoint<Map<String,Object>>

Returns:

the results of the invocation

extract

protected Map<String,Object> extract(ApplicationContext context)

Extract beans annotated ConfigurationProperties and serialize into Map.

configureObjectMapper

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

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