org.springframework.boot.actuate.endpoint

Interface Endpoint<T>

All Known Subinterfaces:

ActionEndpoint<T>

All Known Implementing Classes:

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

public interface Endpoint<T>

An endpoint that can be used to expose useful information to operations. Usually exposed via Spring MVC but could also be exposed using some other technique.

Author:

Phillip Webb, Dave Syer

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.
T	invoke() Called to invoke the endpoint.
boolean	isSensitive() Returns if the endpoint is sensitive, i.e.

Method Detail

getPath

String getPath()

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

isSensitive

boolean isSensitive()

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.

getProduces

MediaType[] getProduces()

Returns the MediaTypes that this endpoint produces or null.

invoke

T invoke()

Called to invoke the endpoint.

Returns:

the results of the invocation