Interface Endpoint<T>
- Type Parameters:
T
- the endpoint data type
- All Known Implementing Classes:
AbstractEndpoint
,AutoConfigurationReportEndpoint
,BeansEndpoint
,ConfigurationPropertiesReportEndpoint
,DumpEndpoint
,EnvironmentEndpoint
,FlywayEndpoint
,HealthEndpoint
,InfoEndpoint
,LiquibaseEndpoint
,LoggersEndpoint
,MetricsEndpoint
,RequestMappingEndpoint
,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. Consider extendingAbstractEndpoint
if you are developing your own endpoint.- See Also:
AbstractEndpoint
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getId()
The logical ID of the endpoint.T
invoke()
Called to invoke the endpoint.boolean
isEnabled()
Return if the endpoint is enabled.boolean
isSensitive()
Return if the endpoint is sensitive, i.e.
Method Detail
getId
String getId()
The logical ID of the endpoint. Must only contain simple letters, numbers and '_' characters (i.e. a "\w" regex).- Returns:
- the endpoint ID
isEnabled
boolean isEnabled()
Return if the endpoint is enabled.- Returns:
- if the endpoint is enabled
isSensitive
boolean isSensitive()
Return 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.- Returns:
- if the endpoint is sensitive