public interface ResourceManagementMBean extends ResourceManagementMBean
The ResourceManagementMBean interface defines resource adaptor-related management operations.
This interface provides extensions to ResourceManagementMBean
for additional Rhino-specific functionality.
OBJECT_NAME, RESOURCE_ADAPTOR_ENTITY_STATE_CHANGE_NOTIFICATION_TYPE
Modifier and Type | Method and Description |
---|---|
void |
activateResourceAdaptorEntity(String entityName)
Activate a resource adaptor entity on all currently live event routing nodes as determined by
RhinoHousekeepingMBean.getEventRouterNodes() . |
void |
activateResourceAdaptorEntity(String entityName,
int[] nodeIDs)
Activate a resource adaptor entity on the specified nodes.
|
void |
deactivateResourceAdaptorEntity(String entityName)
Deactivate a resource adaptor entity on all currently live event routing nodes as determined by
RhinoHousekeepingMBean.getEventRouterNodes() . |
void |
deactivateResourceAdaptorEntity(String entityName,
int[] nodeIDs)
Deactivate a resource adaptor entity on the specified nodes.
|
void |
deactivateResourceAdaptorEntity(String entityName,
int[] nodeIDs,
int[] reassignActivitiesToNodeIDs)
Deactivate a resource adaptor entity on the specified nodes and reassign replicated activities owned by the resource adaptor entity on the deactivating nodes to other cluster nodes.
|
SbbPartID[] |
getBoundSbbParts(String linkName)
Get the set of SBB part component identifiers that identify the SBB parts that are bound to the specified link name by way of a
resource-adaptor-entity-link element in their deployment descriptor. |
SbbID[] |
getBoundSbbs(String linkName) |
ConfigProperties |
getConfigurationProperties(ResourceAdaptorID id) |
ConfigProperties |
getConfigurationProperties(String entityName) |
String[] |
getLinkNames(String entityName) |
int[] |
getNodes(String entityName,
ResourceAdaptorEntityState state)
Get the set of event-router nodes in the primary component where the resource adaptor entity is in the specified state.
|
ResourceAdaptorID |
getResourceAdaptor(String entityName) |
String[] |
getResourceAdaptorEntities(ResourceAdaptorEntityState state)
Get the set of resource adaptor entities that are in a particular state.
|
String[] |
getResourceAdaptorEntities(ResourceAdaptorEntityState state,
int nodeID)
Get the set of resource adaptor entities that are in a particular state on the specified node.
|
String[] |
getResourceAdaptorEntities(ResourceAdaptorID id) |
String[] |
getResourceAdaptorEntities(String[] linkNames) |
String |
getResourceAdaptorEntity(String linkName) |
ObjectName |
getResourceUsageMBean(String entityName) |
Byte[] |
getStartingPriorities(String[] entityNames)
Get an array of starting priorities corresponding to an array of resource adaptor entity names.
|
byte |
getStartingPriority(String entityName)
Get the starting priority for a resource adaptor entity.
|
ResourceAdaptorEntityState |
getState(String entityName)
Get the current state of a resource adaptor entity.
|
ResourceAdaptorEntityState[] |
getState(String entityName,
int[] nodeIDs)
Get the current state of a resource adaptor entity on each of the specified nodes.
|
Byte[] |
getStoppingPriorities(String[] entityNames)
Get an array of stopping priorities corresponding to an array of resource adaptor entity names.
|
byte |
getStoppingPriority(String entityName)
Get the stopping priority for a resource adaptor entity.
|
void |
reassignActivities(String entityName,
int[] fromNodeIDs,
int[] toNodeIDs)
Reassign replicated activities owned by a resource adaptor entity on the specified nodes to other cluster nodes.
|
void |
setStartingPriority(String entityName,
byte priority)
Set the starting priority for a resource adaptor entity.
|
void |
setStoppingPriority(String entityName,
byte priority)
Set the stopping priority for a resource adaptor entity.
|
bindLinkName, createResourceAdaptorEntity, getLinkNames, getResourceAdaptorEntities, removeResourceAdaptorEntity, unbindLinkName, updateConfigurationProperties
void activateResourceAdaptorEntity(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, InvalidStateException, ManagementException
Activate a resource adaptor entity on all currently live event routing nodes as determined by RhinoHousekeepingMBean.getEventRouterNodes()
. The resource adaptor entity must be in the ResourceAdaptorEntityState.INACTIVE
state on all these nodes and transitions to the ResourceAdaptorEntityState.ACTIVE
state on these nodes during this method invocation.
activateResourceAdaptorEntity
in interface ResourceManagementMBean
entityName
- the name of the resource adaptor entity.NullPointerException
- if entityName
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.InvalidStateException
- if the resource adaptor entity is not in the ResourceAdaptorEntityState.INACTIVE
state on all nodes.ManagementException
- if the resource adaptor entity could not be activated due to a system-level failure.void activateResourceAdaptorEntity(String entityName, int[] nodeIDs) throws NullPointerException, InvalidArgumentException, UnrecognizedResourceAdaptorEntityException, InvalidStateException, ManagementException
Activate a resource adaptor entity on the specified nodes.
The resource adaptor entity must be in the ResourceAdaptorEntityState.INACTIVE
state on all specified nodes and transitions to the ResourceAdaptorEntityState.ACTIVE
state on these nodes during this method invocation.
The specified nodes do not have to be current cluster members. For example this method can be used to set the activation state for a resource adaptor entity on nodes yet to be started.
entityName
- the name of the resource adaptor entity.nodeIDs
- the node IDs of the nodes to activate the resource adaptor entity on.NullPointerException
- if either argument is null
.InvalidArgumentException
- if nodeIDs
is zero-length or contains invalid node IDs.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.InvalidStateException
- if the resource adaptor entity is not in the ResourceAdaptorEntityState.INACTIVE
state on all specified nodes.ManagementException
- if the resource adaptor entity could not be activated due to a system-level failure.void deactivateResourceAdaptorEntity(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, InvalidStateException, ManagementException
Deactivate a resource adaptor entity on all currently live event routing nodes as determined by RhinoHousekeepingMBean.getEventRouterNodes()
. The resource adaptor entity must be in the ResourceAdaptorEntityState.ACTIVE
state on all these nodes and transitions to the ResourceAdaptorEntityState.STOPPING
state on these nodes during this method invocation.
The resource adaptor entity spontaneously returns to the ResourceAdaptorEntityState.INACTIVE
state on these nodes once all activities owned by the resource adaptor entity on these nodes have ended.
deactivateResourceAdaptorEntity
in interface ResourceManagementMBean
entityName
- the name of the resource adaptor entity.NullPointerException
- if entityName
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.InvalidStateException
- if the resource adaptor entity is not in the ResourceAdaptorEntityState.ACTIVE
state on all nodes.ManagementException
- if the resource adaptor entity could not be deactivated due to a system-level failure.void deactivateResourceAdaptorEntity(String entityName, int[] nodeIDs) throws NullPointerException, InvalidArgumentException, UnrecognizedResourceAdaptorEntityException, InvalidStateException, ManagementException
Deactivate a resource adaptor entity on the specified nodes.
The resource adaptor entity must be in the ResourceAdaptorEntityState.ACTIVE
state on all specified nodes and transitions to the ResourceAdaptorEntityState.STOPPING
state on these nodes during this method invocation.
The resource adaptor entity spontaneously returns to the ResourceAdaptorEntityState.INACTIVE
state on these nodes once all activities owned by the resource adaptor entity on these nodes have ended.
The specified nodes do not have to be current cluster members. For example this method can be used to set the activation state for a resource adaptor entity on nodes yet to be started.
If the resource adaptor entity owns replicated activities on the deactivating nodes then those activities are left to drain normally by this method.
If ownership of these activities should be reassigned to allow the resource adaptor entity to return to the ResourceAdaptorEntityState.INACTIVE
state quicker then deactivateResourceAdaptorEntity(String, int[], int[])
should be used instead.
Alternatively reassignActivities(String, int[], int[])
may be used after deactivation to perform this reassignment.
entityName
- the name of the resource adaptor entity.nodeIDs
- the node IDs of the nodes to deactivate the resource adaptor entity on.NullPointerException
- if either argument is null
.InvalidArgumentException
- if nodeIDs
is zero-length or contains invalid node IDs.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.InvalidStateException
- if the resource adaptor entity is not in the ResourceAdaptorEntityState.ACTIVE
state on all specified nodes.ManagementException
- if the resource adaptor entity could not be deactivated due to a system-level failure.void deactivateResourceAdaptorEntity(String entityName, int[] nodeIDs, int[] reassignActivitiesToNodeIDs) throws NullPointerException, InvalidArgumentException, UnrecognizedResourceAdaptorEntityException, InvalidStateException, ManagementException
Deactivate a resource adaptor entity on the specified nodes and reassign replicated activities owned by the resource adaptor entity on the deactivating nodes to other cluster nodes.
The resource adaptor entity must be in the ResourceAdaptorEntityState.ACTIVE
state on all specified nodes and transitions to the ResourceAdaptorEntityState.STOPPING
state on these nodes during this method invocation.
The resource adaptor entity spontaneously returns to the ResourceAdaptorEntityState.INACTIVE
state on the deactivating nodes once all non-replicated activities owned by the resource adaptor entity on these nodes have ended.
The specified nodes on which to deactivate the resource adaptor do not have to be current cluster members. For example this method can be used to set the activation state for a resource adaptor entity 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 deactivateResourceAdaptorEntity(String, 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 a 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
state on the node prior to deactivation
the SLEE is in the SleeState.RUNNING
or SleeState.STOPPING
state on the node
Replicated activities for a 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
entityName
- the name of the resource adaptor entity.nodeIDs
- the node IDs of the nodes to deactivate the resource adaptor entity on.reassignActivitiesToNodeIDs
- the set of nodes to reassign replicated activities to.NullPointerException
- if entityName
or nodeIDs
is null
.InvalidArgumentException
- if nodeIDs
is zero-length or contains invalid node IDs, or if reassignActivitiesToNodeIDs
is non-null but the resource adaptor entity is not replicating or if the target nodes are invalid.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.InvalidStateException
- if the resource adaptor entity is not in the ResourceAdaptorEntityState.ACTIVE
state on all specified nodes.ManagementException
- if the resource adaptor entity could not be deactivated due to a system-level failure.void reassignActivities(String entityName, int[] fromNodeIDs, int[] toNodeIDs) throws NullPointerException, InvalidArgumentException, UnrecognizedResourceAdaptorEntityException, InvalidStateException, ManagementException
Reassign replicated activities owned by a resource adaptor entity on the specified nodes to other cluster nodes. The resource adaptor entity must be a replicating resource adaptor entity.
This method has two modes of operation, depending on the value of the toNodeIDs
parameter:
if toNodeIDs
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 toNodeIDs
is an array with at least one element, replicated activities will be reassigned to the specified node(s)
Replicated activities for a 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 on the node
the SLEE is in the SleeState.RUNNING
or SleeState.STOPPING
state on the node
Replicated activities for a 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
entityName
- the name of the resource adaptor entity.fromNodeIDs
- the node IDs of the nodes to reassign activities from.toNodeIDs
- the node IDs of the nodes to reassign the activities to.NullPointerException
- if any argument is null
.InvalidArgumentException
- if entityName
does not correspond with a replicating resource adaptor, or if fromNodeIDs
is zero-length or contains invalid node IDs, or if toNodeIDs
is contains invalid node IDs.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.InvalidStateException
- if the resource adaptor entity is not in the ResourceAdaptorEntityState.ACTIVE
or ResourceAdaptorEntityState.STOPPING
state and the SLEE is not in the SleeState.RUNNING
or SleeState.STOPPING
state on the all specified nodes, or if toNodeIDs
is zero-length and there are no remaining nodes that the activities may be reassigned to.ManagementException
- if the activities could not be reassigned due to a system-level failue.ResourceAdaptorEntityState getState(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
Get the current state of a resource adaptor entity.
This method returns the state of the resource adaptor entity on the node the management client directs the method call at, as determined by RhinoHousekeepingMBean.getNodeID()
.
getState
in interface ResourceManagementMBean
entityName
- the name of the resource adaptor entity.NullPointerException
- if entityName
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the state of the resource adaptor entity could not be obtained due to a system-level failure.ResourceAdaptorEntityState[] getState(String entityName, int[] nodeIDs) throws NullPointerException, InvalidArgumentException, UnrecognizedResourceAdaptorEntityException, ManagementException
Get the current state of a resource adaptor entity on each of the specified nodes.
entityName
- the name of the resource adaptor entity.nodeIDs
- the node IDs of the nodes to return the resource adaptor entity’s state for.nodeIDs
array, and if states = getState(entityName, nodeIDs)
then states[i]
equals the state of the resource adaptor entity on node nodeIDs[i]
. If there is no state information for the resource adaptor entity on a particular node, ResourceAdaptorEntityState.INACTIVE
is returned as the resulting state for the resource adaptor entity on that node.NullPointerException
- if either argument is null
.InvalidArgumentException
- if nodeIDs
contains invalid node IDs.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the state of the resource adaptor entity could not be obtained due to a system-level failure.String[] getResourceAdaptorEntities(ResourceAdaptorEntityState state) throws NullPointerException, ManagementException
Get the set of resource adaptor entities that are in a particular state.
This method returns the set of Services in the specified state on the node the management client directs this method call at, as determined by RhinoHousekeepingMBean.getNodeID()
.
getResourceAdaptorEntities
in interface ResourceManagementMBean
state
- the required state.NullPointerException
- if state
is null
.ManagementException
- if the identifiers could not be obtained due to a system-level failure.String[] getResourceAdaptorEntities(ResourceAdaptorEntityState state, int nodeID) throws NullPointerException, InvalidArgumentException, ManagementException
Get the set of resource adaptor entities that are in a particular state on the specified node.
The specified node does not have to be a current cluster member. For example this method can be used to query the activation state for a resource adpator entity on a node yet to be started.
state
- the required state.NullPointerException
- if state
is null
.InvalidArgumentException
- if nodeID
is an invalid node ID.ManagementException
- if the identifiers could not be obtained due to a system-level failure.int[] getNodes(String entityName, ResourceAdaptorEntityState state) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
Get the set of event-router nodes in the primary component where the resource adaptor entity is in the specified state.
entityName
- the name of the resource adaptor entity.state
- the required state.NullPointerException
- if either argument is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the set of nodes where the resource adaptor entity is in the required state could not be determined due to a system-level failure.void setStartingPriority(String entityName, byte priority) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
Set the starting priority for a resource adaptor entity. The starting priority determines the order in which services and resource adaptor entities together are started when the SLEE transitions from the STOPPED state to the RUNNING state.
Priorities are values between -128 and 127. If a component (service or resource adaptor entity), X, has a numerically higher priority value than another component, Y, then X will be started before Y. Components with the same priority may be started in an arbitrary order, or may be started concurrently.
entityName
- the name of the resource adaptor entity.priority
- the starting priority for the resource adaptor entity.NullPointerException
- if entityName
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the starting priority of the resource adaptor entity could not be updated due to a system-level failure.setStoppingPriority(String, byte)
byte getStartingPriority(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
Get the starting priority for a resource adaptor entity.
entityName
- the name of the resource adaptor entity.NullPointerException
- if id
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the starting priority of the resource adaptor entity could not be obtained due to a system-level failure.setStartingPriority(String, byte)
Byte[] getStartingPriorities(String[] entityNames) throws NullPointerException, ManagementException
Get an array of starting priorities corresponding to an array of resource adaptor entity names.
entityNames
- the array of resource adaptor entity names.priorities = getStartingPriorities(entityNames)
then priorities[i] == getStartingPriority(entityNames[i])
. Any unrecognised resource adaptor entity name present in entityNames
results in a null
value at the corresponding array index in this array.NullPointerException
- if entityNames
is null
.ManagementException
- if the starting priorities could not be obtained due to a system-level failure.void setStoppingPriority(String entityName, byte priority) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
Set the stopping priority for a resource adaptor entity. The stopping priority determines the order in which services and resource adaptor entities together are started when the SLEE transitions from the RUNNING state to the STOPPING state.
Priorities are values between -128 and 127. If a component (service or resource adaptor entity), X, has a numerically higher priority value than another component, Y, then X will be started before Y. Components with the same priority may be started in an arbitrary order, or may be started concurrently.
entityName
- the name of the resource adaptor entity.priority
- the stopping priority for the resource adaptor entity.NullPointerException
- if entityName
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the stopping priority of the resource adaptor entity could not be updated due to a system-level failure.setStartingPriority(String, byte)
byte getStoppingPriority(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
Get the stopping priority for a resource adaptor entity.
entityName
- the name of the resource adaptor entity.NullPointerException
- if id
is null
.UnrecognizedResourceAdaptorEntityException
- if entityName
does not correspond with a resource adaptor entity existing in the SLEE.ManagementException
- if the stopping priority of the resource adaptor entity could not be obtained due to a system-level failure.setStartingPriority(String, byte)
Byte[] getStoppingPriorities(String[] entityNames) throws NullPointerException, ManagementException
Get an array of stopping priorities corresponding to an array of resource adaptor entity names.
entityNames
- the array of resource adaptor entity names.priorities = getStoppingPriorities(entityNames)
then priorities[i] == getStoppingPriority(entityNames[i])
. Any unrecognised resource adaptor entity name present in entityNames
results in a null
value at the corresponding array index in this array.NullPointerException
- if entityNames
is null
.ManagementException
- if the stopping priorities could not be obtained due to a system-level failure.String[] getResourceAdaptorEntities(ResourceAdaptorID id) throws NullPointerException, UnrecognizedResourceAdaptorException, ManagementException
getResourceAdaptorEntities
in interface ResourceManagementMBean
NullPointerException
UnrecognizedResourceAdaptorException
ManagementException
String[] getResourceAdaptorEntities(String[] linkNames) throws NullPointerException, ManagementException
getResourceAdaptorEntities
in interface ResourceManagementMBean
NullPointerException
ManagementException
ConfigProperties getConfigurationProperties(ResourceAdaptorID id) throws NullPointerException, UnrecognizedResourceAdaptorException, ManagementException
getConfigurationProperties
in interface ResourceManagementMBean
NullPointerException
UnrecognizedResourceAdaptorException
ManagementException
ConfigProperties getConfigurationProperties(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
getConfigurationProperties
in interface ResourceManagementMBean
NullPointerException
UnrecognizedResourceAdaptorEntityException
ManagementException
ResourceAdaptorID getResourceAdaptor(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
getResourceAdaptor
in interface ResourceManagementMBean
NullPointerException
UnrecognizedResourceAdaptorEntityException
ManagementException
String[] getLinkNames(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, ManagementException
getLinkNames
in interface ResourceManagementMBean
NullPointerException
UnrecognizedResourceAdaptorEntityException
ManagementException
SbbID[] getBoundSbbs(String linkName) throws NullPointerException, UnrecognizedLinkNameException, ManagementException
getBoundSbbs
in interface ResourceManagementMBean
NullPointerException
UnrecognizedLinkNameException
ManagementException
SbbPartID[] getBoundSbbParts(String linkName) throws UnrecognizedLinkNameException, ManagementException
Get the set of SBB part component identifiers that identify the SBB parts that are bound to the specified link name by way of a resource-adaptor-entity-link
element in their deployment descriptor.
linkName
- the link name.NullPointerException
- if linkName
is null
.UnrecognizedLinkNameException
- if linkName
has not been bound to a resource adaptor entity.ManagementException
- if the SBB part component identifiers could not be obtained due to a system-level failure.String getResourceAdaptorEntity(String linkName) throws NullPointerException, UnrecognizedLinkNameException, ManagementException
getResourceAdaptorEntity
in interface ResourceManagementMBean
NullPointerException
UnrecognizedLinkNameException
ManagementException
ObjectName getResourceUsageMBean(String entityName) throws NullPointerException, UnrecognizedResourceAdaptorEntityException, InvalidArgumentException, ManagementException
getResourceUsageMBean
in interface ResourceManagementMBean
NullPointerException
UnrecognizedResourceAdaptorEntityException
InvalidArgumentException
ManagementException