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

Annotation Type ControllerEndpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Endpoint
 @FilteredEndpoint(value=org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointFilter.class)
public @interface ControllerEndpoint

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:

WebEndpoint, RestControllerEndpoint

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The id of the endpoint.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	enableByDefault If the endpoint should be enabled or disabled by default.

Element Detail

id

@AliasFor(annotation=Endpoint.class)
public abstract String id

The id of the endpoint.

Returns:

the id

enableByDefault

@AliasFor(annotation=Endpoint.class)
public abstract boolean enableByDefault

If the endpoint should be enabled or disabled by default.

Returns:

true if the endpoint is enabled by default

Default:

true