org.springframework.boot.actuate.endpoint.jmx

Class EndpointMBean

java.lang.Object

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

Direct Known Subclasses:

DataEndpointMBean, ShutdownEndpointMBean

@ManagedResource
public class EndpointMBean
extends Object

Simple wrapper around Endpoint implementations to enable JMX export.

Author:

Christian Dupuis, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
EndpointMBean(String beanName, Endpoint<?> endpoint) Deprecated. since 1.3 in favor of EndpointMBean(String, Endpoint, ObjectMapper)
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 result)
Endpoint<?>	getEndpoint()
String	getEndpointClass()
boolean	isSensitive()

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointMBean

@Deprecated
public EndpointMBean(String beanName,
                                 Endpoint<?> endpoint)

Deprecated. since 1.3 in favor of EndpointMBean(String, Endpoint, ObjectMapper)

Create a new EndpointMBean instance.

Parameters:

beanName - the bean name

endpoint - the endpoint to wrap

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()

isSensitive

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

getEndpoint

public Endpoint<?> getEndpoint()

convert

protected Object convert(Object result)