Package com.opencloud.rhino.management.pool

Interface PoolManagementMBean

public interface PoolManagementMBean

The PoolManagementMBean interface provides methods for obtaining information about the pool clustering mode and the state of a Rhino node pool.

Since:

Rhino 3.2

Field Summary

Fields

Modifier and Type	Field	Description
static String	MBEAN_NAME	The name of this MBean, equal to the string "PoolManagement".
static String	OBJECT_NAME	The JMX Object Name of this MBean.

Method Summary

Modifier and Type	Method	Description
String	getNodeID()	Get the node ID for this node.
TabularData	getNodeMetadata()	Get metadata information about all known pool nodes.
CompositeData	getNodeMetadata(String nodeID)	Get metadata information about the specified node.
boolean	getPoolModeEnabled()	Determine if this node is configured to use the pool clustering mode.
String[]	getPoolNodeIDs()	Get the node IDs for all known pool nodes.
boolean	isAlive(String nodeID)	Get the liveness status of the specified node.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

The name of this MBean, equal to the string "PoolManagement".

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

The JMX Object Name of this MBean.

See Also:

Constant Field Values

Method Detail

getPoolModeEnabled

boolean getPoolModeEnabled()
                    throws ManagementException

Determine if this node is configured to use the pool clustering mode.

Returns:

true if this node is configured to use the pool clustering mode, false otherwise.

Throws:

ManagementException - if the operation could not be successfully completed due to a system-level failure.

Since:

Rhino 3.2

getNodeID

String getNodeID()
          throws ManagementException

Get the node ID for this node.

Returns:

the node ID.

Throws:

ManagementException - if the operation could not be successfully completed due to a system-level failure.

Since:

Rhino 3.2

getPoolNodeIDs

String[] getPoolNodeIDs()
                 throws IllegalStateException,
                        ManagementException

Get the node IDs for all known pool nodes.

Returns:

the node IDs for all known pool nodes.

Throws:

IllegalStateException - if the node is not configured to use the pool clustering mode.

ManagementException - if the operation could not be successfully completed due to a system-level failure.

Since:

Rhino 3.2

isAlive

boolean isAlive(String nodeID)
         throws NullPointerException,
                IllegalStateException,
                ManagementException

Get the liveness status of the specified node.

Parameters:

nodeID - the node ID of target node.

Returns:

true if the specified node is considered alive, false otherwise. Any unknown node ID will also return false.

Throws:

NullPointerException - if nodeID is null.

IllegalStateException - if the node is not configured to use the pool clustering mode.

ManagementException - if the operation could not be successfully completed due to a system-level failure.

Since:

Rhino 3.2

getNodeMetadata

TabularData getNodeMetadata()
                     throws IllegalStateException,
                            ManagementException

Get metadata information about all known pool nodes.

This method returns TabularData, keyed on the node ID, where each row of the data is a CompositeData element as returned by getNodeMetadata(String) for that node.

Returns:

metadata info

Throws:

IllegalStateException - if the node is not configured to use the pool clustering mode.

ManagementException - if the operation could not be successfully completed due to a system-level failure.

Since:

Rhino 3.2

getNodeMetadata

CompositeData getNodeMetadata(String nodeID)
                       throws NullPointerException,
                              IllegalStateException,
                              ManagementException

Get metadata information about the specified node.

The CompositeData object returned by this method has the structure given below. Note that a node booting into a cluster may temporarily report a null value in some fields for information that is not yet available.

Field	Open Type	Description
node-id	String	Rhino pool node ID
rhino-version	String	The version of the Rhino node
liveness-state	String	The heartbeat liveness state of the node. One of: undetermined, alive, assumed-alive, or dead. A node has the state assumed-alive if it was previously known to be alive but a database connection failure is preventing any further state update.
node-state	String	The operational state of the node. One of: BOOTING, OPERATIONAL, SHUTDOWN.
actual-slee-state	String	The actual SLEE state of the node. One of the enum values defined by SleeActualState.
interconnect-address	String	The interconnect address of the node
jmx-address	String	The comma-separated JMX addresses of the node
boot-time	Date	The original boot time of this node
up-time	Long	Time the pool node has been running in milliseconds
last-heartbeat-update-time	Date	The time the node heartbeat state was last updated
last-metadata-update-time	Date	The time the node metadata state was last updated

Parameters:

nodeID - the node ID.

Returns:

metadata information about the specified node, or null if the node ID is unknown or unrecognised.

Throws:

NullPointerException - if nodeID is null.

IllegalStateException - if the node is not configured to use the pool clustering mode.

ManagementException - if the operation could not be successfully completed due to a system-level failure.

Since:

Rhino 3.2