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

Annotation Interface ControllerEndpoint

@Target(TYPE) @Retention(RUNTIME) @Documented @Endpoint @FilteredEndpoint(org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointFilter.class) @Deprecated(since="3.3.0", forRemoval=true) public @interface ControllerEndpoint
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of @Endpoint and @WebEndpoint
Identifies a type as being an endpoint that is only exposed over Spring MVC or Spring WebFlux. Mapped methods must be annotated with @GetMapping, @PostMapping, @DeleteMapping, etc. annotations rather than @ReadOperation, @WriteOperation, @DeleteOperation.

This annotation can be used when deeper Spring integration is required, but at the expense of portability. Most users should prefer the @Endpoint or @WebEndpoint annotation whenever possible.

Since:
2.0.0
Author:
Phillip Webb
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    id
    Deprecated, for removal: This API element is subject to removal in a future version.
    The id of the endpoint.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Access
    defaultAccess
    Deprecated, for removal: This API element is subject to removal in a future version.
    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.
    If the endpoint should be enabled or disabled by default.

  • Element Details

    • enableByDefault

      @AliasFor(annotation=Endpoint.class) boolean enableByDefault
      Deprecated, for removal: This API element is subject to removal in a future version.
      If the endpoint should be enabled or disabled by default.
      Returns:
      true if the endpoint is enabled by default
      Default:
      true

    • defaultAccess

      @AliasFor(annotation=Endpoint.class) Access defaultAccess
      Deprecated, for removal: This API element is subject to removal in a future version.
      Level of access to the endpoint that is permitted by default.
      Returns:
      the default level of access
      Since:
      3.4.0
      Default:
      UNRESTRICTED