org.springframework.boot.actuate.endpoint.jmx

Class EndpointMBean

java.lang.Object

org.springframework.boot.actuate.endpoint.jmx.EndpointMBean

All Implemented Interfaces:

JmxEndpoint

Direct Known Subclasses:

DataEndpointMBean, LoggersEndpointMBean, ShutdownEndpointMBean

public abstract class EndpointMBean
extends Object
implements JmxEndpoint

Base for adapters that convert Endpoint implementations to JmxEndpoint.

Author:

Christian Dupuis, Andy Wilkinson, Vedran Pavic, Phillip Webb

See Also:

JmxEndpoint, DataEndpointMBean

Constructor Summary

Constructors

Constructor and Description
EndpointMBean(String beanName, Endpoint<?> endpoint, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Create a new EndpointMBean instance.

Method Summary

Modifier and Type	Method and Description
protected Object	convert(Object data) Convert the given data into JSON.
Endpoint<?>	getEndpoint()
String	getEndpointClass()
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.
boolean	isSensitive()

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointMBean

public EndpointMBean(String beanName,
                     Endpoint<?> endpoint,
                     com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Create a new EndpointMBean instance.

Parameters:

beanName - the bean name

endpoint - the endpoint to wrap

objectMapper - the ObjectMapper used to convert the payload

Method Detail

getEndpointClass

@ManagedAttribute(description="Returns the class of the underlying endpoint")
public String getEndpointClass()

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

isSensitive

@ManagedAttribute(description="Indicates whether the underlying endpoint exposes sensitive information")
public boolean isSensitive()

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

getEndpoint

public Endpoint<?> getEndpoint()

convert

protected Object convert(Object data)

Convert the given data into JSON.

Parameters:

data - the source data

Returns:

the JSON representation