org.ow2.jonas.jmx
Interface JmxService

All Superinterfaces:

Service

All Known Implementing Classes:

BaseJMXService, JOnASJMXService

public interface JmxService
extends Service

JMX Service interface.

Method Summary

JMXServiceURL[]	getConnectorServerURLs()
String	getDomainName()
MBeanServer	getJmxServer()
MBeanServerConnection	getJmxServerConnection()
String	getJonasServerName()
<T> String	getObjectName(T instance)
void	loadDescriptors(String packageName, ClassLoader cl) Load additional mbean descriptors.
void	registerMBean(Object mbean, ObjectName objectName) Register an MBean on the JOnAS MBeanServer.
void	registerMBean(Object mbean, String objectName) Register an MBean on the JOnAS MBeanServer.
<T> String	registerMBean(T instance) Register the instance as a ModelMBean using the delegate.
void	registerModelMBean(Object mbean, ObjectName objectName) Register a Model MBean on the JOnAS MBeanServer.
void	registerModelMBean(Object mbean, String objectName) Register a Model MBean on the JOnAS MBeanServer.
void	unregisterMBean(ObjectName objectName) Unregister an MBean from the JOnAS MBeanServer.
<T> void	unregisterMBean(T instance) Unregister the given Object.
void	unregisterModelMBean(ObjectName objectName) Unegister a Model MBean from the JOnAS MBeanServer.

Methods inherited from interface org.ow2.jonas.service.Service

getName, init, isStarted, setName, start, stop

Method Detail

getJmxServer

MBeanServer getJmxServer()

Returns:

The reference of the MBean server

getJmxServerConnection

MBeanServerConnection getJmxServerConnection()

Returns:

The Connection interface to the MBean server

registerMBean

void registerMBean(Object mbean,
                   String objectName)

Register an MBean on the JOnAS MBeanServer.

Parameters:

mbean - MBean to be registered

objectName - Stringified ObjectName of the MBean to be registered

registerMBean

void registerMBean(Object mbean,
                   ObjectName objectName)

Register an MBean on the JOnAS MBeanServer.

Parameters:

mbean - MBean to be registered

objectName - ObjectName of the MBean to be registered

unregisterMBean

void unregisterMBean(ObjectName objectName)

Unregister an MBean from the JOnAS MBeanServer.

Parameters:

objectName - the MBean's ObjectName

registerModelMBean

void registerModelMBean(Object mbean,
                        String objectName)
                        throws Exception

Register a Model MBean on the JOnAS MBeanServer.

Parameters:

mbean - MBean to be registered

objectName - Stringified ObjectName of the MBean to be registered

Throws:

Exception - throwed when registering a modeler MBean

registerModelMBean

void registerModelMBean(Object mbean,
                        ObjectName objectName)
                        throws Exception

Register a Model MBean on the JOnAS MBeanServer.

Parameters:

mbean - MBean to be registered

objectName - ObjectName of the MBean to be registered

Throws:

Exception - throwed when registering a modeler MBean

unregisterModelMBean

void unregisterModelMBean(ObjectName objectName)

Unegister a Model MBean from the JOnAS MBeanServer.

Parameters:

objectName - the Mbean ObjectName

loadDescriptors

void loadDescriptors(String packageName,
                     ClassLoader cl)

Load additional mbean descriptors.

Parameters:

packageName - name of the package containing the descriptors file

cl - class loader containing the resource

getConnectorServerURLs

JMXServiceURL[] getConnectorServerURLs()

Returns:

Returns a JMXServiceURL array containing the adresses associated to the JMX connector servers

getJonasServerName

String getJonasServerName()

Returns:

The current server name

getDomainName

String getDomainName()

Returns:

The current management domain name

registerMBean

<T> String registerMBean(T instance)
                     throws Exception

Register the instance as a ModelMBean using the delegate.

Type Parameters:

T - instance Type

Parameters:

instance - Object instance to be managed

Returns:

the MBean's OBJECT_NAME

Throws:

Exception - if registration fails.

unregisterMBean

<T> void unregisterMBean(T instance)
                     throws Exception

Unregister the given Object.

Type Parameters:

T - instance Type

Parameters:

instance - Instance to be deregistered.

Throws:

Exception - if unregistration fails.

getObjectName

<T> String getObjectName(T instance)
                     throws ServiceException

Type Parameters:

T - instance Type

Parameters:

instance - Object instance to be managed

Returns:

Returns the instance ObjectName.

Throws:

ServiceException - if registration fails.