org.apache.uima.aae.jmx
Interface JmxManagement

All Known Implementing Classes:

JmxManager

public interface JmxManagement

Jmx Management interface for registering and unregistering MBeans.

Method Summary

void	destroy() Performs cleanup when object goes out of scope
java.lang.String	getJmxDomain() Returns configured Jmx Domain
javax.management.MBeanServer	getMBeanServer() Returns instance of an MBeanServer
void	initialize(java.util.Map anInitMap) Initializes instnace of this interface using provided properties
void	registerMBean(java.lang.Object anMBean, javax.management.ObjectName anMBeanName) Registers given MBean with MBeanServer
void	setJmxDomain(java.lang.String aJmxDomain) Sets the Jmx Domain
void	unregisterMBean(javax.management.ObjectName anMBeanName) Removed an MBean from the MBeanServer registry

Method Detail

initialize

void initialize(java.util.Map anInitMap)
                throws java.lang.Exception

Initializes instnace of this interface using provided properties

Parameters:

anInitMap - - properties required during initialization

Throws:

java.lang.Exception

getMBeanServer

javax.management.MBeanServer getMBeanServer()

Returns instance of an MBeanServer

Returns:

getJmxDomain

java.lang.String getJmxDomain()

Returns configured Jmx Domain

Returns:

setJmxDomain

void setJmxDomain(java.lang.String aJmxDomain)

Sets the Jmx Domain

Parameters:

aJmxDomain -

registerMBean

void registerMBean(java.lang.Object anMBean,
                   javax.management.ObjectName anMBeanName)
                   throws java.lang.Exception

Registers given MBean with MBeanServer

Parameters:

anMBean - - instance of MBean to register

anMBeanName - - name of the MBean

Throws:

java.lang.Exception

unregisterMBean

void unregisterMBean(javax.management.ObjectName anMBeanName)

Removed an MBean from the MBeanServer registry

Parameters:

anMBeanName -

destroy

void destroy()
             throws java.lang.Exception

Performs cleanup when object goes out of scope

Throws:

java.lang.Exception