org.flowable.management.jmx

Interface ManagementAgent

All Known Implementing Classes:

DefaultManagementAgent

public interface ManagementAgent

Flowable JMX service agent

Author:

Saeid Mirzaei

Method Summary

Modifier and Type	Method and Description
void	doStart()
void	findAndRegisterMbeans()
MBeanServer	getMBeanServer() Get the MBeanServer which hosts managed objects.
boolean	isRegistered(ObjectName name) Is the given object registered
void	register(Object obj, ObjectName name) Registers object with management infrastructure with a specific name.
void	register(Object obj, ObjectName name, boolean forceRegistration) Registers object with management infrastructure with a specific name.
void	setMBeanServer(MBeanServer mbeanServer) Sets a custom mbean server to use
void	unregister(ObjectName name) Unregisters object based upon registered name

Method Detail

register

void register(Object obj,
              ObjectName name)
       throws JMException

Registers object with management infrastructure with a specific name. Object must be annotated or implement standard MBean interface.

Parameters:

obj - the object to register

name - the name

Throws:

JMException - is thrown if the registration failed

register

void register(Object obj,
              ObjectName name,
              boolean forceRegistration)
       throws JMException

Registers object with management infrastructure with a specific name. Object must be annotated or implement standard MBean interface.

Parameters:

obj - the object to register

name - the name

forceRegistration - if set to true, then object will be registered despite existing object is already registered with the name.

Throws:

JMException - is thrown if the registration failed

unregister

void unregister(ObjectName name)
         throws JMException

Unregisters object based upon registered name

Parameters:

name - the name

Throws:

JMException - is thrown if the unregistration failed

isRegistered

boolean isRegistered(ObjectName name)

Is the given object registered

Parameters:

name - the name

Returns:

true if registered

getMBeanServer

MBeanServer getMBeanServer()

Get the MBeanServer which hosts managed objects.

Notice: If the JMXEnabled configuration is not set to true, this method will return null.

Returns:

the MBeanServer

setMBeanServer

void setMBeanServer(MBeanServer mbeanServer)

Sets a custom mbean server to use

Parameters:

mbeanServer - the custom mbean server

findAndRegisterMbeans

void findAndRegisterMbeans()
                    throws Exception

Throws:

Exception

doStart

void doStart()