org.eclipse.tptp.monitoring.instrumentation.internal.jmx
Interface MBeanRegister

All Known Implementing Classes:

MBeanRegisterSupport

public interface MBeanRegister

An interface that is used to register MBeans. It is important that the MBean server is set before the registerMBean are called.

Since:

TPTP 4.4

Field Summary

static java.lang.String	NAME The name key used for the ObjectName.
static java.lang.String	TOPIC The topic key used for the ObjectName.
static java.lang.String	TYPE The type key used for the ObjectName.

Method Summary

java.lang.String	getTopic() Returns the mbean topic name.
javax.management.ObjectName	registerMBean(java.lang.Object object) Registers the given Object with JMX server supplied by the user.
void	registerMBean(java.lang.Object object, javax.management.ObjectName objectName) Registers the given Object with JMX server supplied by the user.
void	setServer(javax.management.MBeanServer server) The MBeanServer instance to register Mbeans.

Field Detail

NAME

public static final java.lang.String NAME

The name key used for the ObjectName.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

The type key used for the ObjectName.

See Also:

Constant Field Values

TOPIC

public static final java.lang.String TOPIC

The topic key used for the ObjectName.

See Also:

Constant Field Values

Method Detail

registerMBean

public javax.management.ObjectName registerMBean(java.lang.Object object)
                                          throws MBeanCreateException

Registers the given Object with JMX server supplied by the user.

Parameters:

object - the object to register with the Mbean server

Returns:

the ObjectName

Throws:

MBeanCreateException - unable to create the Mbean

registerMBean

public void registerMBean(java.lang.Object object,
                          javax.management.ObjectName objectName)
                   throws MBeanCreateException

Registers the given Object with JMX server supplied by the user.

Parameters:

object - the object to register with the Mbean server

objectName - the JMX ObjectName

Throws:

MBeanCreateException - unable to create the Mbean

setServer

public void setServer(javax.management.MBeanServer server)

The MBeanServer instance to register Mbeans.

Parameters:

server - The MBeanServer instance.

getTopic

public java.lang.String getTopic()

Returns the mbean topic name.

Returns:

the mbean topic name.