Interface MvcEndpoint
- All Known Subinterfaces:
NamedMvcEndpoint
- All Known Implementing Classes:
AbstractEndpointMvcAdapter
,AbstractMvcEndpoint
,AbstractNamedMvcEndpoint
,AuditEventsMvcEndpoint
,DocsMvcEndpoint
,EndpointMvcAdapter
,EnvironmentMvcEndpoint
,HalBrowserMvcEndpoint
,HalJsonMvcEndpoint
,HealthMvcEndpoint
,HeapdumpMvcEndpoint
,JolokiaMvcEndpoint
,LogFileMvcEndpoint
,LoggersMvcEndpoint
,MetricsMvcEndpoint
,ShutdownMvcEndpoint
public interface MvcEndpoint
A strategy for the MVC layer on top of anEndpoint
. 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 theEndpointHandlerMapping
).- See Also:
NamedMvcEndpoint
Field Summary
Fields Modifier and Type Field Description static org.springframework.http.ResponseEntity<Map<String,String>>
DISABLED_RESPONSE
AResponseEntity
returned for disabled endpoints.
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Class<? extends Endpoint>
getEndpointType()
Return the type ofEndpoint
exposed, ornull
if thisMvcEndpoint
exposes information that cannot be represented as a traditionalEndpoint
.String
getPath()
Return the MVC path of the endpoint.boolean
isSensitive()
Return if the endpoint exposes sensitive information.
Field Detail
DISABLED_RESPONSE
static final org.springframework.http.ResponseEntity<Map<String,String>> DISABLED_RESPONSE
AResponseEntity
returned for disabled endpoints.
Method Detail
isSensitive
boolean isSensitive()
Return if the endpoint exposes sensitive information.- Returns:
- if the endpoint is sensitive
getEndpointType
Class<? extends Endpoint> getEndpointType()
Return the type ofEndpoint
exposed, ornull
if thisMvcEndpoint
exposes information that cannot be represented as a traditionalEndpoint
.- Returns:
- the endpoint type