org.springframework.boot.actuate.endpoint.mvc

Interface MvcEndpoint

All Known Implementing Classes:

EndpointMvcAdapter, EnvironmentMvcEndpoint, HealthMvcEndpoint, JolokiaMvcEndpoint, ManagementErrorEndpoint, MetricsMvcEndpoint, ShutdownMvcEndpoint

public interface MvcEndpoint

A strategy for the MVC layer on top of an Endpoint. Implementations are allowed to use @RequestMapping and the full Spring MVC machinery, but should not use @Controller or @RequestMapping at the type level (since that would lead to a double mapping of paths, once by the regular MVC handler mappings and once by the EndpointHandlerMapping).

Author:

Dave Syer

Method Summary

Methods

Modifier and Type	Method and Description
Class<? extends Endpoint>	getEndpointType() Return the type of Endpoint exposed, or null if this MvcEndpoint exposes information that cannot be represented as a traditional Endpoint.
String	getPath() Return the MVC path of the endpoint.
boolean	isSensitive() Return if the endpoint exposes sensitive information.

Method Detail

getPath

String getPath()

Return the MVC path of the endpoint.

Returns:

the endpoint path

isSensitive

boolean isSensitive()

Return if the endpoint exposes sensitive information.

Returns:

if the endpoint is sensitive

getEndpointType

Class<? extends Endpoint> getEndpointType()

Return the type of Endpoint exposed, or null if this MvcEndpoint exposes information that cannot be represented as a traditional Endpoint.

Returns:

the endpoint type