org.springframework.boot.actuate.endpoint

Class AbstractEndpoint<T>

java.lang.Object

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

All Implemented Interfaces:

Endpoint<T>

Direct Known Subclasses:

BeansEndpoint, DumpEndpoint, EnvironmentEndpoint, HealthEndpoint, InfoEndpoint, MetricsEndpoint, ShutdownEndpoint, TraceEndpoint

public abstract class AbstractEndpoint<T>
extends Object
implements Endpoint<T>

Abstract base for Endpoint implementations.

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor and Description
AbstractEndpoint(String path)
AbstractEndpoint(String path, boolean sensitive)

Method Summary

Methods

Modifier and Type	Method and Description
String	getPath() Returns the path of the endpoint.
MediaType[]	getProduces() Returns the MediaTypes that this endpoint produces or null.
boolean	isSensitive() Returns if the endpoint is sensitive, i.e.
void	setPath(String path)
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 path)

AbstractEndpoint

public AbstractEndpoint(String path,
                boolean sensitive)

Method Detail

getPath

public String getPath()

Description copied from interface: Endpoint

Returns the path of the endpoint. Must start with '/' and should not include wildcards.

Specified by:

getPath in interface Endpoint<T>

setPath

public void setPath(String path)

isSensitive

public boolean isSensitive()

Description copied from interface: Endpoint

Returns 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>

setSensitive

public void setSensitive(boolean sensitive)

getProduces

public MediaType[] getProduces()

Description copied from interface: Endpoint

Returns the MediaTypes that this endpoint produces or null.

Specified by:

getProduces in interface Endpoint<T>