org.springframework.boot.actuate.endpoint.jmx

Class AbstractJmxEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.jmx.AbstractJmxEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, JmxEndpoint, org.springframework.context.EnvironmentAware

Direct Known Subclasses:

AuditEventsJmxEndpoint

public abstract class AbstractJmxEndpoint
extends Object
implements JmxEndpoint, org.springframework.context.EnvironmentAware

Abstract base class for JmxEndpoint implementations without a backing Endpoint.

Since:

1.5.0

Author:

Vedran Pavic, Phillip Webb

Constructor Summary

Constructors

Constructor and Description
AbstractJmxEndpoint(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
protected Object	convert(Object data) Convert the given data into JSON.
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.
protected org.springframework.core.env.Environment	getEnvironment()
String	getIdentity() Return the MBean identity for this endpoint.
boolean	isEnabled() Return if the JMX endpoint is enabled.
void	setEnabled(Boolean enabled)
void	setEnvironment(org.springframework.core.env.Environment environment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJmxEndpoint

public AbstractJmxEndpoint(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

getEnvironment

protected final org.springframework.core.env.Environment getEnvironment()

isEnabled

public boolean isEnabled()

Description copied from interface: JmxEndpoint

Return if the JMX endpoint is enabled.

Specified by:

isEnabled in interface JmxEndpoint

Returns:

if the endpoint is enabled

setEnabled

public void setEnabled(Boolean enabled)

getIdentity

public String getIdentity()

Description copied from interface: JmxEndpoint

Return the MBean identity for this endpoint.

Specified by:

getIdentity in interface JmxEndpoint

Returns:

the MBean identity.

getEndpointType

public Class<? extends Endpoint> getEndpointType()

Description copied from interface: JmxEndpoint

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

Specified by:

getEndpointType in interface JmxEndpoint

Returns:

the endpoint type

convert

protected Object convert(Object data)

Convert the given data into JSON.

Parameters:

data - the source data

Returns:

the JSON representation