org.springframework.boot.actuate.endpoint

Class AbstractEndpoint<T>

java.lang.Object

org.springframework.boot.actuate.endpoint.AbstractEndpoint<T>

Type Parameters:

T - the endpoint data type

All Implemented Interfaces:

org.springframework.beans.factory.Aware, Endpoint<T>, org.springframework.context.EnvironmentAware

Direct Known Subclasses:

AutoConfigurationReportEndpoint, BeansEndpoint, ConfigurationPropertiesReportEndpoint, DumpEndpoint, EnvironmentEndpoint, FlywayEndpoint, HealthEndpoint, InfoEndpoint, LiquibaseEndpoint, LoggersEndpoint, MetricsEndpoint, RequestMappingEndpoint, ShutdownEndpoint, TraceEndpoint

public abstract class AbstractEndpoint<T>
extends Object
implements Endpoint<T>, org.springframework.context.EnvironmentAware

Abstract base for Endpoint implementations.

Author:

Phillip Webb, Christian Dupuis

Constructor Summary

Constructors

Constructor and Description
AbstractEndpoint(String id) Create a new sensitive endpoint instance.
AbstractEndpoint(String id, boolean sensitive) Create a new endpoint instance.
AbstractEndpoint(String id, boolean sensitive, boolean enabled) Create a new endpoint instance.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.core.env.Environment	getEnvironment()
String	getId() The logical ID of the endpoint.
boolean	isEnabled() Return if the endpoint is enabled.
boolean	isSensitive() Return if the endpoint is sensitive, i.e.
void	setEnabled(Boolean enabled)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setId(String id)
void	setSensitive(Boolean sensitive)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.endpoint.Endpoint

invoke

Constructor Detail

AbstractEndpoint

public AbstractEndpoint(String id)

Create a new sensitive endpoint instance. The endpoint will enabled flag will be based on the spring Environment unless explicitly set.

Parameters:

id - the endpoint ID

AbstractEndpoint

public AbstractEndpoint(String id,
                        boolean sensitive)

Create a new endpoint instance. The endpoint will enabled flag will be based on the spring Environment unless explicitly set.

Parameters:

id - the endpoint ID

sensitive - if the endpoint is sensitive by default

AbstractEndpoint

public AbstractEndpoint(String id,
                        boolean sensitive,
                        boolean enabled)

Create a new endpoint instance.

Parameters:

id - the endpoint ID

sensitive - if the endpoint is sensitive

enabled - if the endpoint is enabled or not.

Method Detail

getEnvironment

protected final org.springframework.core.env.Environment getEnvironment()

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

getId

public String getId()

Description copied from interface: Endpoint

The logical ID of the endpoint. Must only contain simple letters, numbers and '_' characters (i.e. a "\w" regex).

Specified by:

getId in interface Endpoint<T>

Returns:

the endpoint ID

setId

public void setId(String id)

isEnabled

public boolean isEnabled()

Description copied from interface: Endpoint

Return if the endpoint is enabled.

Specified by:

isEnabled in interface Endpoint<T>

Returns:

if the endpoint is enabled

setEnabled

public void setEnabled(Boolean enabled)

isSensitive

public boolean isSensitive()

Description copied from interface: Endpoint

Return if the endpoint is sensitive, i.e. may return data that the average user should not see. Mappings can use this as a security hint.

Specified by:

isSensitive in interface Endpoint<T>

Returns:

if the endpoint is sensitive

setSensitive

public void setSensitive(Boolean sensitive)