org.springframework.boot.actuate.endpoint.mvc

Interface NamedMvcEndpoint

All Superinterfaces:

MvcEndpoint

All Known Implementing Classes:

AbstractEndpointMvcAdapter, AbstractNamedMvcEndpoint, AuditEventsMvcEndpoint, DocsMvcEndpoint, EndpointMvcAdapter, EnvironmentMvcEndpoint, HalBrowserMvcEndpoint, HalJsonMvcEndpoint, HealthMvcEndpoint, HeapdumpMvcEndpoint, JolokiaMvcEndpoint, LogFileMvcEndpoint, LoggersMvcEndpoint, MetricsMvcEndpoint, ShutdownMvcEndpoint

public interface NamedMvcEndpoint
extends MvcEndpoint

An MvcEndpoint that also includes a logical name. Unlike endpoints paths, it should not be possible for a user to change the endpoint name. Names provide a consistent way to reference an endpoint, for example they may be used as the 'rel' attribute in a HAL response.

Since:

1.5.0

Author:

Madhura Bhave

Field Summary

Fields inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

DISABLED_RESPONSE

Method Summary

Modifier and Type	Method and Description
String	getName() Return the logical name of the endpoint.

Methods inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

getEndpointType, getPath, isSensitive

Method Detail

getName

String getName()

Return the logical name of the endpoint. Names should be non-null, non-empty, alpha-numeric values.

Returns:

the logical name of the endpoint