org.springframework.boot.actuate.env

Class EnvironmentEndpoint

java.lang.Object

org.springframework.boot.actuate.env.EnvironmentEndpoint

@Endpoint(id="env")
public class EnvironmentEndpoint
extends Object

@Endpoint to expose environment information.

Since:

2.0.0

Author:

Dave Syer, Phillip Webb, Christian Dupuis, Madhura Bhave, Stephane Nicoll, Scott Frederick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentEndpoint.EnvironmentDescriptor A description of an Environment.
static class	EnvironmentEndpoint.EnvironmentEntryDescriptor A description of an entry of the Environment.
static class	EnvironmentEndpoint.PropertySourceDescriptor A description of a PropertySource.
static class	EnvironmentEndpoint.PropertySourceEntryDescriptor A description of a particular entry of PropertySource.
static class	EnvironmentEndpoint.PropertySummaryDescriptor A summary of a particular entry of the Environment.
static class	EnvironmentEndpoint.PropertyValueDescriptor A description of a property's value, including its origin if available.

Constructor Summary

Constructors

Constructor and Description
EnvironmentEndpoint(Environment environment)
EnvironmentEndpoint(Environment environment, Iterable<SanitizingFunction> sanitizingFunctions)

Method Summary

Modifier and Type	Method and Description
EnvironmentEndpoint.EnvironmentDescriptor	environment(String pattern)
EnvironmentEndpoint.EnvironmentEntryDescriptor	environmentEntry(String toMatch)
void	keysToSanitize(String... keysToSanitize)
Object	sanitize(String key, Object value) Deprecated. since 2.6.0 for removal in 2.8.0 as sanitization should be internal to the class
void	setKeysToSanitize(String... keysToSanitize)
protected Object	stringifyIfNecessary(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentEndpoint

public EnvironmentEndpoint(Environment environment)

EnvironmentEndpoint

public EnvironmentEndpoint(Environment environment,
                           Iterable<SanitizingFunction> sanitizingFunctions)

Method Detail

setKeysToSanitize

public void setKeysToSanitize(String... keysToSanitize)

keysToSanitize

public void keysToSanitize(String... keysToSanitize)

environment

@ReadOperation
public EnvironmentEndpoint.EnvironmentDescriptor environment(@Nullable
                                                                            String pattern)

environmentEntry

@ReadOperation
public EnvironmentEndpoint.EnvironmentEntryDescriptor environmentEntry(@Selector
                                                                                      String toMatch)

sanitize

@Deprecated
public Object sanitize(String key,
                                   Object value)

Deprecated. since 2.6.0 for removal in 2.8.0 as sanitization should be internal to the class

Apply sanitization to the given name and value.

Parameters:

key - the name to sanitize

value - the value to sanitize

Returns:

the sanitized value

stringifyIfNecessary

protected Object stringifyIfNecessary(Object value)