Package org.springframework.boot.actuate.endpoint.annotation

Annotation Interface Endpoint

@Target(TYPE) @Retention(RUNTIME) @Documented @Reflective public @interface Endpoint
Identifies a type as being an actuator endpoint that provides information about the running application. Endpoints can be exposed over a variety of technologies including JMX and HTTP.

Most @Endpoint classes will declare one or more @ReadOperation, @WriteOperation, @DeleteOperation annotated methods which will be automatically adapted to the exposing technology (JMX, Spring MVC, Spring WebFlux, Jersey etc.).

@Endpoint represents the lowest common denominator for endpoints and intentionally limits the sorts of operation methods that may be defined in order to support the broadest possible range of exposure technologies. If you need deeper support for a specific technology you can either write an endpoint that is filtered to a certain technology, or provide extension for the broader endpoint.

Since:
2.0.0
Author:
Andy Wilkinson, Phillip Webb
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Access
    defaultAccess
    Level of access to the endpoint that is permitted by default.
    boolean
    enableByDefault
    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 defaultAccess()
    String
    id
    The id of the endpoint (must follow EndpointId rules).

  • Element Details

    • id

      String id
      The id of the endpoint (must follow EndpointId rules).
      Returns:
      the id
      See Also:
      Default:
      ""

    • enableByDefault

      @Deprecated(since="3.4.0", forRemoval=true) boolean enableByDefault
      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 defaultAccess()
      If the endpoint should be enabled or disabled by default.
      Returns:
      true if the endpoint is enabled by default
      Default:
      true

    • defaultAccess

      Access defaultAccess
      Level of access to the endpoint that is permitted by default.
      Returns:
      the default level of access
      Since:
      3.4.0
      Default:
      UNRESTRICTED