org.springframework.boot.actuate.endpoint.jmx

Class EndpointMBeanExporter

java.lang.Object

org.springframework.jmx.support.MBeanRegistrationSupport

org.springframework.jmx.export.MBeanExporter

org.springframework.boot.actuate.endpoint.jmx.EndpointMBeanExporter

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, MBeanExportOperations

public class EndpointMBeanExporter
extends MBeanExporter
implements SmartLifecycle, ApplicationContextAware

SmartLifecycle bean that registers all known Endpoints with an MBeanServer using the MBeanExporter located from the application context.

Author:

Christian Dupuis, Andy Wilkinson, Vedran Pavic

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOMAIN The default JMX domain.

Fields inherited from class org.springframework.jmx.export.MBeanExporter

AUTODETECT_ALL, AUTODETECT_ASSEMBLER, AUTODETECT_MBEAN, AUTODETECT_NONE

Fields inherited from class org.springframework.jmx.support.MBeanRegistrationSupport

REGISTRATION_FAIL_ON_EXISTING, REGISTRATION_IGNORE_EXISTING, REGISTRATION_REPLACE_EXISTING, server

Constructor Summary

Constructors

Constructor and Description
EndpointMBeanExporter() Create a new EndpointMBeanExporter instance.
EndpointMBeanExporter(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Create a new EndpointMBeanExporter instance.

Method Summary

Modifier and Type	Method and Description
protected JmxEndpoint	adaptEndpoint(String beanName, Endpoint<?> endpoint) Adapt the given Endpoint to a JmxEndpoint.
protected void	doStart()
protected EndpointMBean	getEndpointMBean(String beanName, Endpoint<?> endpoint) Deprecated. as of 1.5 in favor of adaptEndpoint(String, Endpoint)
protected ObjectName	getObjectName(Object bean, String beanKey)
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
protected void	locateAndRegisterEndpoints()
protected void	registerEndpoint(String beanName, Endpoint<?> endpoint) Deprecated. as of 1.5 in favor of direct JmxEndpoint registration or adaptEndpoint(String, Endpoint)
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanFactory(BeanFactory beanFactory)
void	setDomain(String domain)
void	setEnsureUniqueRuntimeObjectNames(boolean ensureUniqueRuntimeObjectNames)
void	setObjectNameStaticProperties(Properties objectNameStaticProperties)
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class org.springframework.jmx.export.MBeanExporter

adaptMBeanIfPossible, addExcludedBean, afterPropertiesSet, afterSingletonsInstantiated, createAndConfigureMBean, createModelMBean, destroy, isBeanDefinitionLazyInit, isMBean, onRegister, onUnregister, registerBeanNameOrInstance, registerBeans, registerManagedResource, registerManagedResource, setAllowEagerInit, setAssembler, setAutodetect, setAutodetectMode, setAutodetectModeName, setBeanClassLoader, setBeans, setExcludedBeans, setExposeManagedResourceClassLoader, setListeners, setNamingStrategy, setNotificationListenerMappings, setNotificationListeners, unregisterManagedResource

Methods inherited from class org.springframework.jmx.support.MBeanRegistrationSupport

doRegister, doUnregister, getRegisteredObjectNames, getServer, onRegister, setRegistrationBehavior, setRegistrationBehaviorName, setRegistrationPolicy, setServer, unregisterBeans

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

The default JMX domain.

See Also:

Constant Field Values

Constructor Detail

EndpointMBeanExporter

public EndpointMBeanExporter()

Create a new EndpointMBeanExporter instance.

EndpointMBeanExporter

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

Create a new EndpointMBeanExporter instance.

Parameters:

objectMapper - the object mapper

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Specified by:

setBeanFactory in interface BeanFactoryAware

Overrides:

setBeanFactory in class MBeanExporter

setDomain

public void setDomain(String domain)

setEnsureUniqueRuntimeObjectNames

public void setEnsureUniqueRuntimeObjectNames(boolean ensureUniqueRuntimeObjectNames)

Overrides:

setEnsureUniqueRuntimeObjectNames in class MBeanExporter

setObjectNameStaticProperties

public void setObjectNameStaticProperties(Properties objectNameStaticProperties)

doStart

protected void doStart()

locateAndRegisterEndpoints

protected void locateAndRegisterEndpoints()

registerEndpoint

@Deprecated
protected void registerEndpoint(String beanName,
                                            Endpoint<?> endpoint)

Deprecated. as of 1.5 in favor of direct JmxEndpoint registration or adaptEndpoint(String, Endpoint)

Register a regular Endpoint with the MBeanServer.

Parameters:

beanName - the bean name

endpoint - the endpoint to register

adaptEndpoint

protected JmxEndpoint adaptEndpoint(String beanName,
                                    Endpoint<?> endpoint)

Adapt the given Endpoint to a JmxEndpoint.

Parameters:

beanName - the bean name

endpoint - the endpoint to adapt

Returns:

an adapted endpoint

getEndpointMBean

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

Deprecated. as of 1.5 in favor of adaptEndpoint(String, Endpoint)

Get a EndpointMBean for the specified Endpoint.

Parameters:

beanName - the bean name

endpoint - the endpoint

Returns:

an EndpointMBean

getObjectName

protected ObjectName getObjectName(Object bean,
                                   String beanKey)
                            throws MalformedObjectNameException

Overrides:

getObjectName in class MBeanExporter

Throws:

MalformedObjectNameException

getPhase

public final int getPhase()

Specified by:

getPhase in interface Phased

isAutoStartup

public final boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

isRunning

public final boolean isRunning()

Specified by:

isRunning in interface Lifecycle

start

public final void start()

Specified by:

start in interface Lifecycle

stop

public final void stop()

Specified by:

stop in interface Lifecycle

stop

public final void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle