com.opencloud.rhino.management

Interface SleeManagementMBean

All Superinterfaces:

SleeManagementMBean

public interface SleeManagementMBean
extends SleeManagementMBean

The SleeManagementMBean interface defines the central management interface for the SLEE. This interface provides extensions to SleeManagementMBean for additional Rhino-specific functionality.

Field Summary

Fields inherited from interface javax.slee.management.SleeManagementMBean

OBJECT_NAME, SLEE_STATE_CHANGE_NOTIFICATION_TYPE

Method Summary

Modifier and Type	Method and Description
void	annotateLog(String logKey, String logLevel, String message, Throwable throwable) Logs a message to all nodes in the cluster using Rhino’s logging subsystem.
ObjectName	getContainerConfigurationMBean() Get the JMX Object Name of the Container Configuration Management object.
ObjectName	getLimiterManagementMBean() Get the JMX Object Name of the Limiter Manager object.
ObjectName	getNamespaceManagementMBean() Get the JMX Object Name of the Namespace Management object.
int[]	getNodes(SleeState state) Get the set of event-router nodes in the primary component that are in the specified SLEE state.
ObjectName	getRhinoInspectorMBean() Get the JMX Object Name of the Rhino Inspector Housekeeping object.
SleeState	getState() Get the current operational state of the SLEE.
SleeState[]	getState(int[] nodeIDs) Get the current operational state of the SLEE on each of the specified nodes.
ObjectName	getStatsManagementMBean() Get the JMX Object Name of the Stats Management object.
ObjectName	getUsageMBean(String subsystemName)
ObjectName	getUsageMBean(String subsystemName, String paramSetName)
ObjectName	getUsageNotificationManagerMBean(String subsystemName)
String[]	getUsageParameterSets(String subsystemName)
ObjectName	getUserTransactionManagerMBean() Get the JMX Object Name of the User Transaction Manager object.
void	kill(int[] nodeIDs) Forcefully terminate the specified nodes in the cluster.
void	reboot(int[] nodeIDs, SleeState[] rebootStates) Reboot given nodeID’s into given states.
void	reboot(SleeState[] rebootStates)
void	shutdown() Shutdown and terminate the cluster.
void	shutdown(boolean restart) Shutdown and terminate the cluster.
void	shutdown(int[] nodeIDs) Shutdown and terminate the specified nodes in the cluster.
void	shutdown(int[] nodeIDs, boolean restart) Shutdown and terminate the specified nodes in the cluster.
void	shutdown(int[] nodeIDs, long timeout) Shutdown and terminate the specified nodes in the cluster.
void	shutdown(int[] nodeIDs, long timeout, boolean restart) Shutdown and terminate the specified nodes in the cluster.
void	shutdown(long timeout) Shutdown and terminate the cluster.
void	shutdown(long timeout, boolean restart) Shutdown and terminate the cluster.
void	start() Request that the SLEE’s event routing subsystem be started on all currently live event routing nodes as determined by RhinoHousekeepingMBean.getEventRouterNodes().
void	start(int[] nodeIDs) Request that the SLEE’s event routing subsystem be started on the specified nodes.
void	stop() Request that the SLEE’s event routing subsystem be stopped on all currently live event routing nodes as determined by RhinoHousekeepingMBean.getEventRouterNodes().
void	stop(int[] nodeIDs) Request that the SLEE’s event routing subsystem be stopped on the specified nodes.
void	stop(int[] stopNodeIDs, int[] reassignActivitiesToNodeIDs) Request that the SLEE’s event routing subsystem be stopped on the specified nodes.

Methods inherited from interface javax.slee.management.SleeManagementMBean

getAlarmMBean, getDeploymentMBean, getProfileProvisioningMBean, getResourceManagementMBean, getServiceManagementMBean, getSleeName, getSleeVendor, getSleeVersion, getSubsystems, getTraceMBean, hasUsage

Method Detail

start

void start()
    throws InvalidStateException,
           ManagementException

Request that the SLEE’s event routing subsystem be started on all currently live event routing nodes as determined by RhinoHousekeepingMBean.getEventRouterNodes(). The SLEE must currently be in the SleeState.STOPPED state on all these nodes and transitions to SleeState.STARTING state on these nodes during this method invocation. The SLEE spontaneously moves out of the SleeState.STARTING state when conditions dictate.

Specified by:

start in interface SleeManagementMBean

Throws:

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all nodes.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

start

void start(int[] nodeIDs)
    throws NullPointerException,
           InvalidArgumentException,
           InvalidStateException,
           ManagementException

Request that the SLEE’s event routing subsystem be started on the specified nodes. The SLEE must currently be in the SleeState.STOPPED state on all these nodes and transitions to SleeState.STARTING state on these nodes during this method invocation. The SLEE spontaneously moves out of the SleeState.STARTING state when conditions dictate.

The specified nodes do not have to be current cluster members. For example this method can be used to set the activation state for the SLEE on nodes yet to be started.

Parameters:

nodeIDs - the node IDs of the nodes to start the SLEE event-routing functions on.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs is zero-length or contains invalid node IDs.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on the specified nodes.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

stop

void stop()
   throws InvalidStateException,
          ManagementException

Request that the SLEE’s event routing subsystem be stopped on all currently live event routing nodes as determined by RhinoHousekeepingMBean.getEventRouterNodes(). The SLEE must be in the SleeState.RUNNING state on all these nodes and transitions to the SleeState.STOPPING state on all these nodes during this method invocation. The SLEE spontaneously moves out of the SleeState.STOPPING state when conditions dictate.

Specified by:

stop in interface SleeManagementMBean

Throws:

InvalidStateException - if the SLEE is not currently in the SleeState.RUNNING state on all nodes.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

stop

void stop(int[] nodeIDs)
   throws NullPointerException,
          InvalidArgumentException,
          InvalidStateException,
          ManagementException

Request that the SLEE’s event routing subsystem be stopped on the specified nodes. The SLEE must be in the SleeState.RUNNING state on all these nodes and transitions to the SleeState.STOPPING state on all these nodes during this method invocation. The SLEE spontaneously moves out of the SleeState.STOPPING state when conditions dictate.

The specified nodes do not have to be current cluster members. For example this method can be used to set the activation state for the SLEE on nodes yet to be started.

If any resource adaptor entity owns replicated activities on the stopping nodes then those activities are left to drain normally by this method. If ownership of these activities should be reassigned to allow the SLEE to return to the SleeState.STOPPED state quicker then stop(int[], int[]) should be used instead. Alternatively replicated activities may be reassigned for individual resource adaptor entities using the ResourceManagementMBean.reassignActivities(String, int[], int[]) method.

Parameters:

nodeIDs - the node IDs of the nodes to stop the SLEE event-routing functions on.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs is zero-length or contains invalid node IDs.

InvalidStateException - if the SLEE is not currently in the SleeState.RUNNING state on the specified nodes.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

stop

void stop(int[] stopNodeIDs,
          int[] reassignActivitiesToNodeIDs)
   throws NullPointerException,
          InvalidArgumentException,
          InvalidStateException,
          ManagementException

Request that the SLEE’s event routing subsystem be stopped on the specified nodes. The SLEE must be in the SleeState.RUNNING state on all these nodes and transitions to the SleeState.STOPPING state on all these nodes during this method invocation. The SLEE spontaneously moves out of the SleeState.STOPPING state when conditions dictate.

The specified nodes do not have to be current cluster members. For example this method can be used to set the activation state for the SLEE on nodes yet to be started.

This method has several modes of operation, depending on the value of the reassignActivitiesToNodeIDs parameter:

• if reassignActivitiesToNodeIDs is null, this method behaves in the same way as the stop(int[]) method, ie. no replicated activity reassignment takes place

• if reassignActivitiesToNodeIDs is a zero-length array, replicated activities will be reassigned to any other cluster nodes that are capable of taking ownership of the activities; if no nodes satisfy this criteria no activity reassignment takes place

• if reassignActivitiesToNodeIDs is an array with at least one element, replicated activities will be reassigned to the specified node(s)

Replicated activities for an individual resource adaptor entity may only be reassigned from a node if the node meets the following conditions:

• the node is a live cluster member providing event routing functions, ie. not a quorum node

• the resource adaptor entity is in the ResourceAdaptorEntityState.ACTIVE or ResourceAdaptorEntityState.STOPPING state

• the SLEE is in the SleeState.RUNNING state on the node prior to this method being invoked.

Replicated activities for an individual resource adaptor entity may only be reassigned to a node if the node meets the following conditions:

• the node is a live cluster member providing event routing functions, ie. not a quorum node

• the resource adaptor entity is in the ResourceAdaptorEntityState.ACTIVE state on the node

• the SLEE is in the SleeState.RUNNING state on the node

Parameters:

stopNodeIDs - the node IDs of the nodes to stop the SLEE event-routing functions on.

reassignActivitiesToNodeIDs - the set of nodes to reassign replicated activities to.

Throws:

NullPointerException - if stopNodeIDs is null.

InvalidArgumentException - if nodeIDs is zero-length or contains invalid node IDs.

InvalidArgumentException - if stopNodeIDs is zero-length or contains invalid node IDs, or if reassignActivitiesToNodeIDs is non-null and contains invalid node IDs.

InvalidStateException - if the SLEE is not currently in the SleeState.RUNNING state on the specified nodes.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

getState

SleeState getState()
            throws ManagementException

Get the current operational state of the SLEE. This method returns the state of the SLEE on the node the management client directs the method call at, as determined by RhinoHousekeepingMBean.getNodeID().

Specified by:

getState in interface SleeManagementMBean

Returns:

a SleeState object that indicates the current operational state of the SLEE on the invoked node.

Throws:

ManagementException - if the operatioanl state could not be determined due to a system-level failure.

getState

SleeState[] getState(int[] nodeIDs)
              throws NullPointerException,
                     InvalidArgumentException,
                     ManagementException

Get the current operational state of the SLEE on each of the specified nodes.

Parameters:

nodeIDs - the node IDs of the nodes to return the SLEE state for.

Returns:

an array of SLEE state objects. This array will be the same length as the supplied nodeIDs array, and if states = getState(nodeIDs) then states[i] equals the state of the SLEE on node nodeIDs[i]. If there is no state information for the SLEE on a particular node, SleeState.STOPPED is returned as the resulting state for the SLEE on that node.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs.

ManagementException - if the operatioanl state could not be determined due to a system-level failure.

getNodes

int[] getNodes(SleeState state)
        throws NullPointerException,
               ManagementException

Get the set of event-router nodes in the primary component that are in the specified SLEE state.

Parameters:

state - the required state.

Returns:

an array of node IDs identifying the event-router nodes that are in the specified state.

Throws:

NullPointerException - if state is null.

ManagementException - if the set of nodes in the required state could not be determined due to a system-level failure.

shutdown

void shutdown()
       throws InvalidStateException,
              ManagementException

Shutdown and terminate the cluster. All cluster nodes terminate in response to this request. The SLEE must be in the SleeState.STOPPED state on all cluster members.

This method will block for at most the default shutdown flush timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Specified by:

shutdown in interface SleeManagementMBean

Throws:

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes in the cluster.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure, or if the default shutdown timeout period is reached without all required state having been persisted.

shutdown

void shutdown(boolean restart)
       throws InvalidStateException,
              ManagementException

Shutdown and terminate the cluster. All cluster nodes terminate in response to this request. The SLEE must be in the SleeState.STOPPED state on all cluster members.

This method will block for at most the default shutdown flush timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

restart - restart the nodes after shutting them down

Throws:

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes in the cluster.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure, or if the default shutdown timeout period is reached without all required state having been persisted.

shutdown

void shutdown(long timeout)
       throws InvalidStateException,
              ManagementException

Shutdown and terminate the cluster. All cluster nodes terminate in response to this request. The SLEE must be in the SleeState.STOPPED state on all cluster members.

This method will block for at most the specified timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

timeout - the timeout period, measured in milliseconds, in which Rhino will attempt to flush outstanding in-memory database changes to persistent storage. A value less than or equal to 0 indicates an infinite timeout period.

Throws:

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes in the cluster.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure, or if the default shutdown timeout period is reached without all required state having been persisted.

shutdown

void shutdown(long timeout,
              boolean restart)
       throws InvalidStateException,
              ManagementException

Shutdown and terminate the cluster. All cluster nodes terminate in response to this request. The SLEE must be in the SleeState.STOPPED state on all cluster members.

This method will block for at most the specified timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

timeout - the timeout period, measured in milliseconds, in which Rhino will attempt to flush outstanding in-memory database changes to persistent storage. A value less than or equal to 0 indicates an infinite timeout period.

restart - restart the nodes after shutting them down

Throws:

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes in the cluster.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure, or if the default shutdown timeout period is reached without all required state having been persisted.

shutdown

void shutdown(int[] nodeIDs)
       throws NullPointerException,
              InvalidArgumentException,
              InvalidStateException,
              ManagementException

Shutdown and terminate the specified nodes in the cluster. The SLEE must be in the SleeState.STOPPED state on all these nodes.

This method will block for at most the default shutdown flush timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

nodeIDs - the node IDs of the nodes to shut down.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs or contains the IDs of nodes that are not current cluster members.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes specified.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

shutdown

void shutdown(int[] nodeIDs,
              boolean restart)
       throws NullPointerException,
              InvalidArgumentException,
              InvalidStateException,
              ManagementException

Shutdown and terminate the specified nodes in the cluster. The SLEE must be in the SleeState.STOPPED state on all these nodes.

This method will block for at most the default shutdown flush timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

nodeIDs - the node IDs of the nodes to shut down.

restart - restart the nodes after shutting them down

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs or contains the IDs of nodes that are not current cluster members.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes specified.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

shutdown

void shutdown(int[] nodeIDs,
              long timeout)
       throws NullPointerException,
              InvalidArgumentException,
              InvalidStateException,
              ManagementException

Shutdown and terminate the specified nodes in the cluster. The SLEE must be in the SleeState.STOPPED state on all these nodes.

This method will block for at most the specified timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

nodeIDs - the node IDs of the nodes to shut down.

timeout - the timeout period, measured in milliseconds, in which Rhino will attempt to flush outstanding in-memory database changes to persistent storage. A value less than or equal to 0 indicates an infinite timeout period.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs or contains the IDs of nodes that are not current cluster members.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes specified.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

shutdown

void shutdown(int[] nodeIDs,
              long timeout,
              boolean restart)
       throws NullPointerException,
              InvalidArgumentException,
              InvalidStateException,
              ManagementException

Shutdown and terminate the specified nodes in the cluster. The SLEE must be in the SleeState.STOPPED state on all these nodes.

This method will block for at most the specified timeout period. If the timeout period is reached and all required in-memory database state has not yet been flushed to persistent storage, this method will throw a ManagementException.

Parameters:

nodeIDs - the node IDs of the nodes to shut down.

timeout - the timeout period, measured in milliseconds, in which Rhino will attempt to flush outstanding in-memory database changes to persistent storage. A value less than or equal to 0 indicates an infinite timeout period.

restart - restart the nodes after shutting them down

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs or contains the IDs of nodes that are not current cluster members.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes specified.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

reboot

void reboot(int[] nodeIDs,
            SleeState[] rebootStates)
     throws NullPointerException,
            InvalidArgumentException,
            InvalidStateException,
            ManagementException

Reboot given nodeID’s into given states. Array orders must match. This method delegates to shutdown() to perform the restart. As such, the Slee must be stopped before rebooting.

Parameters:

nodeIDs - the node IDs of the nodes to shut down.

rebootStates - the states to set the Slee to after rebooting (true for SleeState.RUNNING.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs or contains the IDs of nodes that are not current cluster members. Also if rebootStates length differs from nodeIDs length.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes specified.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

reboot

void reboot(SleeState[] rebootStates)
     throws InvalidArgumentException,
            InvalidStateException,
            ManagementException

Parameters:

rebootStates - the states to set the Slee to after rebooting (true for SleeState.RUNNING.

Throws:

InvalidArgumentException - if rebootStates length differs from number of event router nodes.

InvalidStateException - if the SLEE is not currently in the SleeState.STOPPED state on all event-router nodes specified.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

kill

void kill(int[] nodeIDs)
   throws NullPointerException,
          InvalidArgumentException,
          ManagementException

Forcefully terminate the specified nodes in the cluster. The nodes terminate immediately without grace.

Parameters:

nodeIDs - the node IDs of the nodes to shut down.

Throws:

NullPointerException - if nodeIDs is null.

InvalidArgumentException - if nodeIDs contains invalid node IDs

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

getRhinoInspectorMBean

ObjectName getRhinoInspectorMBean()
                           throws ManagementException

Get the JMX Object Name of the Rhino Inspector Housekeeping object.

Returns:

the Object Name of the RhinoInspectorMBean object.

Throws:

ManagementException

getStatsManagementMBean

ObjectName getStatsManagementMBean()
                            throws ManagementException

Get the JMX Object Name of the Stats Management object.

Returns:

the Object Name of the StatsManagementMBean object.

Throws:

ManagementException

getContainerConfigurationMBean

ObjectName getContainerConfigurationMBean()
                                   throws ManagementException

Get the JMX Object Name of the Container Configuration Management object.

Returns:

the Object Name of the ContainerConfigurationManagementMBean object.

Throws:

ManagementException

getNamespaceManagementMBean

ObjectName getNamespaceManagementMBean()
                                throws ManagementException

Get the JMX Object Name of the Namespace Management object.

Returns:

the JMX Object Name of the NamespaceManagementMBean object.

Throws:

ManagementException

getUserTransactionManagerMBean

ObjectName getUserTransactionManagerMBean()
                                   throws ManagementException

Get the JMX Object Name of the User Transaction Manager object.

Returns:

the JMX Object Name of the UserTransactionManagerMBean object.

Throws:

ManagementException

getLimiterManagementMBean

ObjectName getLimiterManagementMBean()
                              throws ManagementException

Get the JMX Object Name of the Limiter Manager object.

Returns:

the JMX Object Name of the LimiterManagementMBean object.

Throws:

ManagementException

annotateLog

void annotateLog(String logKey,
                 String logLevel,
                 String message,
                 Throwable throwable)
          throws ManagementException

Logs a message to all nodes in the cluster using Rhino’s logging subsystem.

Parameters:

logKey - log key to log to

logLevel - log level to log at

message - the message to log

throwable - optional throwable to log (may be null)

Throws:

ManagementException

getUsageMBean

ObjectName getUsageMBean(String subsystemName)
                  throws NullPointerException,
                         UnrecognizedSubsystemException,
                         InvalidArgumentException,
                         ManagementException

Specified by:

getUsageMBean in interface SleeManagementMBean

Throws:

NullPointerException

UnrecognizedSubsystemException

InvalidArgumentException

ManagementException

getUsageMBean

ObjectName getUsageMBean(String subsystemName,
                         String paramSetName)
                  throws NullPointerException,
                         UnrecognizedSubsystemException,
                         InvalidArgumentException,
                         UnrecognizedUsageParameterSetNameException,
                         ManagementException

Specified by:

getUsageMBean in interface SleeManagementMBean

Throws:

NullPointerException

UnrecognizedSubsystemException

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageNotificationManagerMBean

ObjectName getUsageNotificationManagerMBean(String subsystemName)
                                     throws NullPointerException,
                                            UnrecognizedSubsystemException,
                                            InvalidArgumentException,
                                            ManagementException

Specified by:

getUsageNotificationManagerMBean in interface SleeManagementMBean

Throws:

NullPointerException

UnrecognizedSubsystemException

InvalidArgumentException

ManagementException

getUsageParameterSets

String[] getUsageParameterSets(String subsystemName)
                        throws NullPointerException,
                               UnrecognizedSubsystemException,
                               InvalidArgumentException,
                               ManagementException

Specified by:

getUsageParameterSets in interface SleeManagementMBean

Throws:

NullPointerException

UnrecognizedSubsystemException

InvalidArgumentException

ManagementException