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

Annotation Type ServletEndpoint

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

Identifies a type as being an endpoint that supplies a servlet to expose. Implementations must also implement Supplier<EndpointServlet> and return a valid EndpointServlet.

This annotation can be used when existing servlets need to be exposed as actuator endpoints, but it is at the expense of portability. Most users should prefer the @Endpoint or @WebEndpoint annotations whenever possible.

Since:

2.0.0

Author:

Phillip Webb

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