org.springframework.boot.actuate.endpoint.jmx

Interface JmxEndpoint

All Known Implementing Classes:

AbstractJmxEndpoint, AuditEventsJmxEndpoint, DataEndpointMBean, EndpointMBean, LoggersEndpointMBean, ShutdownEndpointMBean

public interface JmxEndpoint

A strategy for the JMX layer on top of an Endpoint. Implementations are allowed to use @ManagedAttribute and the full Spring JMX machinery but should not use the @ManagedResource annotation. Implementations may be backed by an actual Endpoint or may be specifically designed for JMX only.

Since:

1.5.0

Author:

Phillip Webb

See Also:

EndpointMBean, AbstractJmxEndpoint

Method Summary

Modifier and Type	Method and Description
Class<? extends Endpoint>	getEndpointType() Return the type of Endpoint exposed, or null if this JmxEndpoint exposes information that cannot be represented as a traditional Endpoint.
String	getIdentity() Return the MBean identity for this endpoint.
boolean	isEnabled() Return if the JMX endpoint is enabled.

Method Detail

isEnabled

boolean isEnabled()

Return if the JMX endpoint is enabled.

Returns:

if the endpoint is enabled

getIdentity

String getIdentity()

Return the MBean identity for this endpoint.

Returns:

the MBean identity.

getEndpointType

Class<? extends Endpoint> getEndpointType()

Return the type of Endpoint exposed, or null if this JmxEndpoint exposes information that cannot be represented as a traditional Endpoint.

Returns:

the endpoint type