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

Annotation Interface JmxEndpoint

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Endpoint
@FilteredEndpoint(org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointFilter.class)
public @interface JmxEndpoint

Identifies a type as being an endpoint that is only exposed over JMX.

Since:

2.0.0

Author:

Stephane Nicoll, Phillip Webb

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
String	id	The id of the endpoint.

Element Details

id

@AliasFor(annotation=Endpoint.class)
String id

The id of the endpoint.

Returns:

the id

Default:

""

enableByDefault

@Deprecated(since="3.4.0",
            forRemoval=true)
@AliasFor(annotation=Endpoint.class)
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

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

Level of access to the endpoint that is permitted by default.

Returns:

the default level of access

Since:

3.4.0

Default:

UNRESTRICTED