org.ow2.proactive.jmx

Class AbstractJMXHelper

java.lang.Object

org.ow2.proactive.jmx.AbstractJMXHelper

Direct Known Subclasses:

RMJMXHelper

public abstract class AbstractJMXHelper
extends Object

This helper class represents the common JMX monitoring infrastructure. Two levels of JMX monitoring are possible using two separate MBeans, one for anonymous users and one for administrators.

Sub-classes must register these MBeans into the MBean server then provide an ObjectName for each MBean.

This helper exposes two connector servers, one over RMI and one over RO (Remote Objects). Each connector server exposes the anonymous MBean for anonymous users and same for admin users.

The service url of the connector server over RMI for anonymous access is built like service:jmx:rmi:///jndi/rmi://HOSTNAME_OR_IP:PORT/NAME where

• HOSTNAME_OR_IP is specified by the ProActive network configuration.
• PORT is provided by sub-classes by the getJMXRMIConnectorServerPort() method.
• NAME is provided by sub-classes by the getConnectorServerName() method.

Once booted with boot(Authentication) infrastructure can be shutdown with the shutdown() method.

Since:

ProActive Scheduling 1.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJMXHelper() Can be called only by sub-classes
protected	AbstractJMXHelper(org.apache.log4j.Logger logger) Can be called only by sub-classes

Method Summary

Modifier and Type	Method and Description
boolean	boot(Authentication auth) Starts the boot sequence of of the JMX monitoring infrastructure with a new JMX server.
boolean	boot(Authentication auth, boolean createNewServer, PermissionChecker permissionChecker) Starts the boot sequence of of the JMX monitoring infrastructure.
JMXServiceURL	getAddress(JMXTransportProtocol protocol) Returns the address of the JMX connector server depending on the specified protocol.
abstract String	getConnectorServerName() Sub-classes must provide the name of the connector server.
RRDDataStore	getDataStore() Gets the RRD data base with statistics.
abstract int	getJMXRMIConnectorServerPort() Sub-classes must provide the port to be used by the JMX RMI connector server.
abstract void	registerMBeans(MBeanServer mbs) Sub-class must register the MBeans into the MBean server.
void	setDataStore(RRDDataStore rrdDataStore) Sets the rrd data store.
void	shutdown() Shutdown the JMX monitoring infrastructure.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJMXHelper

protected AbstractJMXHelper()

Can be called only by sub-classes

AbstractJMXHelper

protected AbstractJMXHelper(org.apache.log4j.Logger logger)

Can be called only by sub-classes

Method Detail

boot

public final boolean boot(Authentication auth)

Starts the boot sequence of of the JMX monitoring infrastructure with a new JMX server.

• Creates a new RMI registry or reuses an existing one needed for the JMX RMI connector server.
• Create a a single MBean server for both administrator users and for anonymous users.
• Registers the MBeans into the MBean server.
• Creates and starts the connector servers, one over RMI and one over RO.

Parameters:

auth - the object responsible for authentication

Returns:

true if the boot sequence was successful (at least one of two connector servers were started), otherwise returns false

boot

public final boolean boot(Authentication auth,
                          boolean createNewServer,
                          PermissionChecker permissionChecker)

Starts the boot sequence of of the JMX monitoring infrastructure.

• Creates a new RMI registry or reuses an existing one needed for the JMX RMI connector server.
• Create a a single MBean server for both administrator users and for anonymous users.
• Registers the MBeans into the MBean server.
• Creates and starts the connector servers, one over RMI and one over RO.

Parameters:

auth - the object responsible for authentication

createNewServer - defined is new JMX server will be created or default will be used.

permissionChecker - additional permission checker

Returns:

true if the boot sequence was successful (at least one of two connector servers were started), otherwise returns false

registerMBeans

public abstract void registerMBeans(MBeanServer mbs)

Sub-class must register the MBeans into the MBean server.

Parameters:

mbs - the MBean server

getConnectorServerName

public abstract String getConnectorServerName()

Sub-classes must provide the name of the connector server.

Returns:

the name of the connector server

getJMXRMIConnectorServerPort

public abstract int getJMXRMIConnectorServerPort()

Sub-classes must provide the port to be used by the JMX RMI connector server. with correct values.

Returns:

the JMX RMI connector server port

shutdown

public void shutdown()

Shutdown the JMX monitoring infrastructure.

getAddress

public JMXServiceURL getAddress(JMXTransportProtocol protocol)
                         throws JMException

Returns the address of the JMX connector server depending on the specified protocol.

Parameters:

protocol - the JMX transport protocol

Returns:

the address of the connector server

Throws:

JMException - in case of boot sequence failure

setDataStore

public void setDataStore(RRDDataStore rrdDataStore)

Sets the rrd data store.

Parameters:

rrdDataStore -

getDataStore

public RRDDataStore getDataStore()

Gets the RRD data base with statistics.

Returns:

RRD data base with statistics.