Package org.springframework.boot.actuate.endpoint

Interface ExposableEndpoint<O extends Operation>

Type Parameters:
O - the type of the endpoint's operations
All Known Subinterfaces:
DiscoveredEndpoint<O>, ExposableControllerEndpoint, ExposableJmxEndpoint, ExposableServletEndpoint, ExposableWebEndpoint
All Known Implementing Classes:
AbstractDiscoveredEndpoint, AbstractExposableEndpoint
public interface ExposableEndpoint<O extends Operation>
Information describing an endpoint that can be exposed in some technology specific way.
Since:
2.0.0
Author:
Andy Wilkinson, Phillip Webb

  • Method Details

    • getEndpointId

      EndpointId getEndpointId()
      Return the endpoint ID.
      Returns:
      the endpoint ID

    • isEnableByDefault

      @Deprecated(since="3.4.0", forRemoval=true) boolean isEnableByDefault()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.4.0 for removal in 3.6.0 in favor of getDefaultAccess()
      Returns if the endpoint is enabled by default.
      Returns:
      if the endpoint is enabled by default

    • getDefaultAccess

      Access getDefaultAccess()
      Returns the access to the endpoint that is permitted by default.
      Returns:
      access that is permitted by default
      Since:
      3.4.0

    • getOperations

      Collection<O> getOperations()
      Returns the operations of the endpoint.
      Returns:
      the operations