org.springframework.boot.actuate.endpoint.jmx

Class EndpointMBeanRegistrar

java.lang.Object

org.springframework.boot.actuate.endpoint.jmx.EndpointMBeanRegistrar

public class EndpointMBeanRegistrar
extends Object

JMX Registrar for EndpointMBean.

Since:

2.0.0

Author:

Stephane Nicoll

See Also:

EndpointObjectNameFactory

Constructor Summary

Constructors

Constructor and Description
EndpointMBeanRegistrar(MBeanServer mBeanServer, EndpointObjectNameFactory objectNameFactory) Create a new instance with the MBeanExporter and EndpointObjectNameFactory to use.

Method Summary

Modifier and Type	Method and Description
ObjectName	registerEndpointMBean(EndpointMBean endpoint) Register the specified EndpointMBean and return its ObjectName.
boolean	unregisterEndpointMbean(ObjectName objectName) Unregister the specified ObjectName if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointMBeanRegistrar

public EndpointMBeanRegistrar(MBeanServer mBeanServer,
                              EndpointObjectNameFactory objectNameFactory)

Create a new instance with the MBeanExporter and EndpointObjectNameFactory to use.

Parameters:

mBeanServer - the mbean exporter

objectNameFactory - the ObjectName factory

Method Detail

registerEndpointMBean

public ObjectName registerEndpointMBean(EndpointMBean endpoint)

Register the specified EndpointMBean and return its ObjectName.

Parameters:

endpoint - the endpoint to register

Returns:

the ObjectName used to register the endpoint

unregisterEndpointMbean

public boolean unregisterEndpointMbean(ObjectName objectName)

Unregister the specified ObjectName if necessary.

Parameters:

objectName - the ObjectName of the endpoint to unregister

Returns:

true if the endpoint was unregistered, false if no such endpoint was found