org.springframework.boot.actuate.endpoint

Class EnvironmentEndpoint

java.lang.Object

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

org.springframework.boot.actuate.endpoint.EnvironmentEndpoint

All Implemented Interfaces:

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

@ConfigurationProperties(prefix="endpoints.env",
                         ignoreUnknownFields=false)
public class EnvironmentEndpoint
extends AbstractEndpoint<Map<String,Object>>
implements EnvironmentAware

Endpoint to expose environment information.

Author:

Dave Syer, Phillip Webb, Christian Dupuis

Constructor Summary

Constructors

Constructor and Description
EnvironmentEndpoint() Create a new EnvironmentEndpoint instance.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	invoke() Called to invoke the endpoint.
Object	sanitize(String name, Object object)
void	setEnvironment(Environment environment)
void	setKeysToSanitize(String... keysToSanitize)

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

getId, isEnabled, isSensitive, setEnabled, setId, setSensitive

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentEndpoint

public EnvironmentEndpoint()

Create a new EnvironmentEndpoint instance.

Method Detail

setKeysToSanitize

public void setKeysToSanitize(String... keysToSanitize)

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

sanitize

public Object sanitize(String name,
              Object object)

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

Overrides:

setEnvironment in class AbstractEndpoint<Map<String,Object>>