The primary key of the activity. This key uniquely identifies the activity within the SLEE.
Interface NodeHousekeepingMBean
-
public interface NodeHousekeepingMBean
The NodeHousekeepingMBean MBean interface provides methods for inspecting Rhino SLEE state.
Methods are provided for locating, inspecting, and in some cases removing Rhino SLEE internal state. These methods are intended to assist in application debugging in addition to preventing downtime caused by unexpected faults in a production system.
Clients should obtain the ObjectName of a NodeHousekeepingMBean using
RhinoHousekeepingMBean.getNodeHousekeeping(int)
for a particular node. Operations invoked on a NodeHousekeepingMBean only apply to state visible to that node.Timestamps
Search methods that accept time ranges accept timestamps as long values measured in milliseconds. Because timestamps are considered to be relative to the system time of the Rhino node processing the request some inaccuracy will occur if the system clock’s on client and all cluster nodes are out of sync. In the worst case this simply means too few results may be returned. In all cases where a timestamp parameter is available it is optional and will only be effective if the supplied value is greater than 0.
Searching and result set sizes
None of the search type methods in this MBean will return an unlimited number of entries. This is intended to prevent unacceptable system pauses or latency caused by collating and serialising a huge result set. All search type methods take a
max
parameter which allows the user to limit the result size.Activity Search Results
This
CompositeData
type describes an activity found in an activity search operation. ATabularData
containing records of this type is returned by the methodsgetActivities(int, boolean)
,getActivities(int, String, boolean)
,getActivities(int, String, long, long, long, long, boolean)
, andgetActivities(int, String, long, long, long, long, boolean)
.Field Open Type Description pkey
String
namespace
String
The namespace that the activity exists in.
ra-entity
String
The name of the resource adaptor entity which created this activity.
submission-time
Date
Time at which the activity was first submitted to the SLEE.
update-time
Date
Time at which the activity was last updated (when the most recent database generation record was created).
handle
String
A string representation of the activities activity handle. The format of the string representation depends on the implementation supplied by the activities resource adaptor. Resource adaptors may provide useful diagnostic information in the string representation of the activity handle.
replicated
Boolean
Replicated flag, true for activities replicated using the legacy savanna framework, false otherwise. Please note that as of Rhino 2.6.1 this attribute is deprecated. The
replication-mode
attribute provides more detailed replication information.replication-mode
String
The replication mode of the activity. Will be one of:
-
NONE
- not replicated, -
SAVANNA
- activity is replicated using the savanna framework, or -
KEY_VALUE_STORE
- activity is replicated using the key/value store for the namespace.
node
Integer
Node ID of the cluster member which is now responsible for processing events on this activity. Negative values indicate a non-resident activity, ie. an activity whose state is currently only stored remotely by, for example, a key/value store. The absolute value of the node ID identifies the node that was last responsible for processing events on the activity.
attach-count
Integer
The number of SBBs attached to the activity.
ref-count
Integer
An internal count of the number of references made to the activity through activity context naming or the timer facility.
Attached Activity Search Results
This
CompositeData
type describes an attached activity found in a query of activities attached to an SBB entity. ATabularData
table with this record type is returned by the methodsgetAttachedActivities(int, ServiceID, SbbID, String)
andgetAttachedActivities(int, ServiceID, SbbID, String, boolean)
.Field Open Type Description pkey
String
The primary key of the activity. This key uniquely identifies the activity within the SLEE.
namespace
String
The namespace that activity exists in.
handle
String
A string representation of the activities activity handle. The format of the string representation depends on the implementation supplied by the activities resource adaptor. Resource adaptors may provide useful diagnostic information in the string representation of the activity handle.
ra-entity
String
The name of the resource adaptor entity which created this activity.
replicated
Boolean
Replicated flag, true for replicated activities, false for non-replicated activities.
SBB Entity Search Results
This
CompositeData
type describes an SBB entity found in an SBB entity search operation. ATabularData
object containing a table of SBB entity search resultCompositeData
objects is returned by the methodsgetSbbs(int, ServiceID)
,getSbbs(int, ServiceID, long, long)
,getSbbs(int, ServiceID, SbbID, long, long)
, andgetSbbs(int, ServiceID, SbbID, long, long)
.Field Open Type Description pkey
String
The primary key of the SBB entity. This key uniquely identifies the SBB entity within its Service and SBB component type.
namespace
String
The namespace that the SBB exists in.
parent-pkey
String
The primary key of this SBB entities parent SBB if it has one, otherwise null.
service-component-id
String
The service component ID of the service to which the SBB entity belongs.
sbb-component-id
String
The SBB component ID of the SBB component to which the SBB entity belongs.
creation-time
Date
The time at which the SBB entity was first created. This field can be used to tell how old an SBB entity is.
node
Integer
Node ID of the cluster member which is currently responsible for delivering events to the SBB entity. Negative values indicate a non-resident SBB entity, ie. an SBB entity whose state is currently only stored remotely by, for example, a key/value store. The absolute value of the node ID identifies the node that was last responsible for delivering events to the SBB entity.
replicated
Boolean
Replicated flag, true for replicated SBB entities, false for non-replicated SBB entities.
Timer Search Results
Describes a timer returned by a timer search operation. A
TabularData
object containing a table of timer infoCompositeData
objects is returned by the methodsgetTimers(int)
andgetTimers(int, java.lang.String, long, long)
. This is also included in the information returned by the methodsgetActivityInfo(String, boolean)
andgetActivityInfo(String, boolean, boolean)
.Field Open Type Description pkey
String
The primary key of the timer. This key uniquely identifies the timer within the SLEE.
namespace
String
The namespace that the timer exists in.
activity-pkey
String
The primary key of the SLEE activity this timer is attached to.
submission-time
Date
The date the timer was created.
period
Long
The timers period.
repetitions
Integer
Number of repetitions of the timer.
preserve-missed
String
Behaviour when a timer is missed. One of:
-
NONE - do not preserve missed,
-
ALL - preserve all missed events, or
-
LAST - Preserve last missed event.
replicated
Boolean
Replicated flag, true for replicated timers entities, false for non-replicated timers. A timer is replicated if the activity it is attached to is replicated.
remote-timer-pkey
String
The primary key of the remote timer created for this timer, if any.
Remote Timer Search Results
Describes a remote timer returned by a remote timer search operation. A
TabularData
object containing a table of timer infoCompositeData
objects is returned by the methodsgetRemoteTimers(int)
andgetRemoteTimers(int, java.lang.String, long, long)
.Field Open Type Description pkey
String
The primary key of the remote timer. This key uniquely identifies the remote timer within the SLEE.
namespace
String
The namespace that the timer exists in.
activity-pkey
String
The primary key of the SLEE activity this timer is attached to.
submission-time
Date
The date the timer was created.
interval
Long
The initial time period after the timer was created before the first firing.
period
Long
The timers period, if a repeating timer.
expiry-time
Date
The date that the timer will expire.
callback-node
Integer
The node that will receive a callback with the timer event when the timer next fires. May be null if the assigned callback address for the timer is not currently reachable.
Activity Context Binding Search Results
Describes an activity context naming facility binding returned by an AC binding search operation. A
TabularData
object containing a table of activity context bindingCompositeData
objects is returned by the methodsgetBoundActivities(int)
andgetBoundActivities(int, long, long)
.Field Open Type Description name
String
The name the activity is bound under. This name is unique within the SLEE.
pkey
String
The primary key of the bound activity.
namespace
String
The namespace that the activity exists in.
submission-time
Date
The time the activity was bound.
replicated
Boolean
Replicated flag, true for replicated activity context bindings, false for non-replicated bindings. A binding is replicated if the bound activity is replicated.
Activity Information
Detailed information about an activity is returned in a
CompositeData
object by the methodsgetActivityInfo(String, boolean)
andgetActivityInfo(String, boolean, boolean)
.Field Open Type Description pkey
String
The primary key of the activity. This key uniquely identifies the activity within the SLEE.
namespace
String
The namespace that the activity exists in.
ra-entity
String
The name of the resource adaptor entity which created this activity.
submission-time
Date
Time at which the activity was first submitted to the SLEE.
update-time
Date
Time at which the activity was last updated (when the most recent database generation record was created).
last-event-time
Date
Time at which the most recent event was submitted on the activity.
creating-gen
Long
Memory database generation in which the activity was created.
flags
String
Hex string representation of activity flags.
handle
String
A string representation of the activities activity handle. The format of the string representation depends on the implementation supplied by the activity’s resource adaptor. Resource adaptors may provide useful diagnostic information in the string representation of the activity handle.
activity
String
A string representation of the activity. The format of the string representation depends on the implementation supplied by the activity’s resource adaptor. Resource adaptors may provide useful diagnostic information in the string representation of the activity.
replicated
Boolean
Replicated flag, true for activities replicated using the legacy savanna framework, false otherwise. Please note that as of Rhino 2.6.1 this attribute is deprecated. The
replication-mode
attribute provides more detailed replication information.replication-mode
String
The replication mode of the activity. Will be one of:
-
NONE
- not replicated, -
SAVANNA
- activity is replicated using the savanna framework, or -
KEY_VALUE_STORE
- activity is replicated using the key/value store for the namespace.
name-bindings
String[]
The name bindings that the activity has in the Activity Context Naming Facility.
head-event
CompositeType
Information about the event at the head of the activity’s event queue, if any.
event-queue
TabularData
Current event queue as
TabularData
.submitting-node
Integer
Node ID of the cluster member on which the activity was created.
node
Integer
Node ID of the cluster member which is now responsible for processing events on this activity. This may differ from the submitting-node if the activity has been failed over. A negative value indicates a non-resident activity, ie. an activity whose state is currently only stored remotely by, for example, a key/value store. The absolute value of the node ID identifies the node that was last responsible for processing events on the activity.
events-submitted
Integer
The number of events that have been submitted for processing on the activity.
suspended
Boolean
Suspended flag, true if the activity is suspended.
ending
Boolean
Ending flag, true if the activity is ending.
generations
TabularData
Activity lifecycle generations as
TabularData
. The format of the tabular data is described in Generation Information.Generation Information
A
CompositeData
object containing details of Activity generations. Returned in Activity Information.Field Open Type Description id
long
Generation ID.
removed
Boolean
True if the generation has been removed.
refcount
Integer
Count of references to the generation.
attached-sbbs
TabularData
Attached sbb’s as
TabularData
. The format of the tabular data is described in Attached SBB Information.timers
TabularData
Attached timers as
TabularData
. The format of the tabular data is described in Timer Search Results.Attached SBB Information
A
CompositeData
object containing identities of attached SBBs. Returned in Generation Information.Field Open Type Description pkey
String
The primary key of the SBB entity. This key uniquely identifies the SBB entity within its Service and SBB component type.
namespace
String
The namespace that the SBB entity exists in.
service-component-id
String
The service component ID of the service to which the SBB entity belongs.
sbb-component-id
String
The SBB component ID of the SBB component to which the SBB entity belongs.
SBB Entity Information
A
CompositeData
object containing detailed SBB Entity information is returned by the methodsgetSbbInfo(ServiceID, SbbID, String)
andgetSbbInfo(ServiceID, SbbID, String, boolean)
.Field Open Type Description pkey
String
The primary key of the SBB entity. This key uniquely identifies the SBB entity within its Service and SBB component type.
service-component-id
String
The service component ID of the service to which the SBB entity belongs.
sbb-component-id
String
The SBB component ID of the SBB component to which the SBB entity belongs.
replicated
Boolean
Replicated flag, true for replicated SBB entities, false for non-replicated SBB entities.
creation-time
Date
The time at which the SBB entity was first created. This field can be used to tell how old an SBB entity is.
attached-activities
TabularData
Attached activities as
TabularData
. The format of the tabular data is described in Attached Activity Search Results.creating-node-id
Integer
The node ID of the cluster member on which this SBB entity was created.
owning-node-id
Integer
Node ID of the cluster member which is currently responsible for delivering events to the SBB entity. Negative values indicate a non-resident SBB entity, ie. an SBB entity whose state is currently only stored remotely by, for example, a key/value store. The absolute value of the node ID identifies the node that was last responsible for delivering events to the SBB entity.
parent-pkey
String
The primary key of this SBB entities parent SBB if it has one, otherwise null.
priority
Integer
Priority for event handling, events are handled sequentially in decending priority order.
convergence-name
String
A string representation of the SLEE convergence name calculated for this SBB entity.
SBB Entity Diagnostic Information
A
CompositeData
object containing detailed SBB Entity information is returned by the methodsgetSbbDiagnostics(ServiceID, SbbID, String)
andgetSbbDiagnostics(ServiceID, SbbID, String, boolean)
.Field Open Type Description pkey
String
The primary key of the SBB entity. This key uniquely identifies the SBB entity within its Service and SBB component type.
namespace
String
The namespace that the SBB entity exists in.
service-component-id
String
The service component ID of the service to which the SBB entity belongs.
sbb-component-id
String
The SBB component ID of the SBB component to which the SBB entity belongs.
replicated
Boolean
Replicated flag, true for replicated SBB entities, false for non-replicated SBB entities.
creation-time
Date
The time at which the SBB entity was first created. This field can be used to tell how old an SBB entity is.
attached-activities
TabularData
Attached activities as
TabularData
. The format of the tabular data is described in Attached Activity Search Results.creating-node-id
Integer
The node ID of the cluster member on which this SBB entity was created.
owning-node-id
Integer
Node ID of the cluster member which is currently responsible for delivering events to the SBB entity. Negative values indicate a non-resident SBB entity, ie. an SBB entity whose state is currently only stored remotely by, for example, a key/value store. The absolute value of the node ID identifies the node that was last responsible for delivering events to the SBB entity.
parent-pkey
String
The primary key of this SBB entities parent SBB if it has one, otherwise null.
priority
Integer
Priority for event handling, events are handled sequentially in descending priority order.
convergence-name
String
A string representation of the SLEE convergence name calculated for this SBB entity.
diagnostics
String
A string representation of the result of calling getSbbDiagnostics() for this SBB entity.
Timer Information
A
CompositeData
object containing detailed timer information is returned by the methodgetTimerInfo(String)
.Field Open Type Description pkey
String
The primary key of the timer. This key uniquely identifies the timer within the SLEE.
namespace
String
The namespace that the timer exists in.
activity-pkey
String
The primary key of the SLEE activity this timer is attached to.
ra-entity
String
The name of the resource adaptor entity which created the activity on which this timer is set.
submission-time
Date
The date the timer was created.
next-firing-time
Date
The date the timer will next fire.
period
Long
The timers period.
repetitions
Integer
Number of repetitions of the timer.
remaining
Integer
Number of remaining repetitions of the timer.
preserve-missed
String
Behaviour when a timer is missed. One of:
* NONE - do not preserve missed, ALL - preserve all missed events, or LAST - Preserve last missed event.
node
Integer
The node currently responsible for scheduling the timer.
replicated
Boolean
Replicated flag, true for replicated timers entities, false for non-replicated timers. A timer is replicated if the activity it is attached to is replicated.
remote-timer-pkey
String
The primary key of the remote timer created for this timer, if any.
Remote Timer Information
A
CompositeData
object containing detailed timer information is returned by the methodgetRemoteTimerInfo(String)
.Field Open Type Description pkey
String
The primary key of the remote timer. This key uniquely identifies the remote timer within the SLEE.
namespace
String
The namespace that the timer exists in.
activity-pkey
String
The primary key of the SLEE activity this timer is attached to.
ra-entity
String
The name of the resource adaptor entity which created the activity on which this timer is set.
submission-time
Date
The date the timer was created.
next-firing-time
Date
The date the timer will next fire.
interval
Long
The initial time period after the timer was created before the first firing.
period
Long
The timers period, if a repeating timer.
expiry-time
Date
The date that the timer will expire.
callback-node
Integer
The node that will receive a callback with the timer event when the timer next fires. May be null if the assigned callback address for the timer is not currently reachable.
pops
Integer
The number of times that the timer has already fired.
Long-running Transaction Search Results
A
CompositeData
object containing detailed transaction information is returned by the methodgetLongRunningTransactions(int, int)
.Field Open Type Description node
Integer
The node ID of the cluster member on which this transaction was created.
transaction-id
Long
The transaction ID of this transaction.
age
Integer
The age of the transaction, measured in seconds.
description
String
A description of why the transaction was created.
Event Router State Results
A
CompositeData
object containing a snapshot of the status of an event router thread as returned bygetEventRouterThreadState(boolean)
.Field
Type
Description
node
Integer
The node ID of the cluster member on which this event router thread exists.
name
String
The name of this thread.
stage
String
Stage the thread is processing.
activity-pkey
String
If the thread is processing an event the encoded activity pkey of that events activity.
event
String
If the thread is processing an event the event type id.
initial
Boolean
If the thread is processing an event then indicates whether the event router has created a new root SBB for the event.
tx-id
Long
If the thread has started an event processing transaction then the id of the transaction.
service-component-id
String
If the thread is processing an event and determined which SBB it will deliver to then the SBB’s service component id.
sbb-component-id
String
If the thread is processing an event and determined which SBB it will deliver to then the SBB’s service component id.
Transaction State Information
A
CompositeData
object containing transaction state information as returned bygetTransactionStateInfo(int, long)
.Field
Type
Description
id
String
A string representation of the transaction identifier.
description
String
A description of the transaction, if provided when the transaction was started.
start-time
Date
The time the transaction was started.
last-update-time
Date
The time of the most recent transaction status change.
status
String
The current status of the transaction.
outstanding-resources
Tabular Data
The list of resources the transaction manager is still waiting on for this transaction. This list will only contain entries if the transaction status is PREPARING, COMMITTING, or ROLLING_BACK. The format of this tabular data is described in Transaction Resource State Information.
Transaction Resource State Information
A
CompositeData
object containing information about a transactional resource. ATabularData
table containing records of this type is included in Transaction State Information.Field
Type
Description
resource-name
String
The name of the transactional resource.
diagnostics
String
Additional diagnostic information provided by the resource regarding the state of the transaction.
-
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
cancelRemoteTimer(String remoteTimerID)
Cancel a remote timer.void
cancelTimer(String timerID)
Cancel a SLEE timer.boolean
copyPerNodeActivationState(int targetNodeID)
Copy the current per-node desired state of services, resource adaptor entities, and the SLEE from this node to the specified target node.TabularData
getActivities(int maxPerNode, boolean includeRemoved)
Return summary information about activities in the SLEE.TabularData
getActivities(int maxPerNode, String entityName, boolean includeRemoved)
Return summary information about activities in the SLEE belonging to a specific resource adaptor entity.TabularData
getActivities(int maxPerNode, String entityName, long createdAfter, long createdBefore, long updatedAfter, long updatedBefore, boolean includeRemoved)
Return summary information about active activities in the SLEE, with optional bounds on the owning resource adaptor entity, activity creation time, and last update time.TabularData
getActivities(int maxPerNode, String entityName, long createdAfter, long createdBefore, long updatedAfter, long updatedBefore, boolean includeRemoved, boolean includeNonResident)
Deprecated.Support for scanning the key/value store for all non-resident activities has been removed.CompositeData
getActivityInfo(String activityPKey, boolean showAllGenerations)
Get information about a SLEE activity.CompositeData
getActivityInfo(String activityPKey, boolean showAllGenerations, boolean nonResident)
Get information about a SLEE activity.TabularData
getAttachedActivities(int maxPerNode, ServiceID serviceID, SbbID sbbID, String sbbPKey)
Return a table of activities attached to an SBB entity.TabularData
getAttachedActivities(int maxPerNode, ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident)
Return a table of activities attached to an SBB entity.TabularData
getBoundActivities(int maxPerNode)
Find activity context naming facility bindings.TabularData
getBoundActivities(int maxPerNode, long createdAfter, long createdBefore)
Find activity context naming facility bindings.String
getDesiredStates()
Get a summary report of all default and per-node desired states set for services, resource adaptor entities, and the SLEE.TabularData
getEventRouterThreadState(boolean includeIdleThreads)
Retrieve the current status of all event router threads.TabularData
getLocalMemDBStripingNodeConfig()
Returns the current MemDB striping configuration for local MemDB instances on this node.TabularData
getLongRunningTransactions(int maxPerNode, int minAge)
Return summary information about long-running transactions in the SLEE.int[]
getNodesWithPerNodeActivationState()
Get the set of node IDs for which per-node desired state currently exists.CompositeData
getRemoteTimerInfo(String remoteTimerID)
Get information about a remote timer.TabularData
getRemoteTimers(int maxPerNode)
Find remote SLEE timers.TabularData
getRemoteTimers(int maxPerNode, String raEntity, long createdAfter, long createdBefore)
Find remote SLEE timers.TabularData
getRemovedActivities(int maxPerNode, String entityName, long createdAfter, long createdBefore, long updatedAfter, long updatedBefore)
Return summary information about removed but not yet garbage collected activities in the SLEE, with optional bounds on the owning resource adaptor entity, activity creation time, and last update time.CompositeData
getSbbDiagnostics(ServiceID serviceID, SbbID sbbID, String sbbPKey)
Return diagnostic information about the state of a particular SBB entity.CompositeData
getSbbDiagnostics(ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident)
Return diagnostic information about the state of a particular SBB entity.CompositeData
getSbbInfo(ServiceID serviceID, SbbID sbbID, String sbbPKey)
Return detailed information about the state of a particular SBB entity.CompositeData
getSbbInfo(ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident)
Return detailed information about the state of a particular SBB entity.TabularData
getSbbs(int maxPerNode, ServiceID serviceID)
Return a table of SBB entities belonging to a Service.TabularData
getSbbs(int maxPerNode, ServiceID serviceID, long createdAfter, long createdBefore)
Return a table of SBB entities belonging to a ServiceTabularData
getSbbs(int maxPerNode, ServiceID serviceID, SbbID sbbType, long createdAfter, long createdBefore)
Returns a table of SBB entities constrained by service component id, SBB component id and creation timeTabularData
getSbbs(int maxPerNode, ServiceID serviceID, SbbID sbbType, long createdAfter, long createdBefore, boolean includeNonResident)
Deprecated.Support for scanning the key/value store for all non-resident SBB entities has been removed.CompositeData
getTimerInfo(String timerID)
Get information about a SLEE timer.TabularData
getTimers(int maxPerNode)
Find active SLEE timersTabularData
getTimers(int maxPerNode, String raEntity, long createdAfter, long createdBefore)
Find active SLEE timersCompositeData
getTransactionStateInfo(int nodeID, long transactionID)
Get information about a transaction.boolean
hasPerNodeActivationState()
Determine if this node has any per-node desired state in existence.void
initiateCleanup(String raEntityName)
Initiate a cleanup of activities that have been removed but not garbage collected.void
initiateGlobalCleanup()
Initiate a cleanup of all in-memory database and activity state.void
removeActivity(String activityPKey)
Remove an activity.void
removeActivity(String activityPKey, boolean nonResident)
Remove an activity.void
removeActivityBinding(String activityPKey, String name)
Remove an activity context naming facility binding.void
removeActivityBinding(String activityPKey, String name, boolean nonResident)
Remove an activity context naming facility binding.boolean
removePerNodeActivationState()
Remove all per-node desired state for services, resource adaptor entities, and the SLEE from this node.void
removeSbb(ServiceID serviceID, SbbID sbbID, String sbbPKey)
Removes an SBB entity.void
removeSbb(ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident)
Removes an SBB entity.void
rollbackLongRunningTransaction(int nodeID, long transactionID)
Force rollback of a long-running transaction.
-
-
-
Method Detail
-
getActivities
TabularData getActivities(int maxPerNode, boolean includeRemoved) throws ManagementException
Return summary information about activities in the SLEE.
The results are returned as
TabularData
where each entry is aCompositeData
containing summary information about a SLEE activity. Refer to Activity Search Results in the interface description for a description of theCompositeData
records returned by this method.This method is equivalent to invoking
getActivities(int, String, long, long, long, long, boolean)
, passing the parametersgetActivities(maxPerNode, null, -1, -1, -1, -1, includeRemoved);
- Parameters:
maxPerNode
- maximum number of activities to return from each node.includeRemoved
- boolean flag indicating if removed but not yet garbage collected activities should be included in the results.- Returns:
- activity information as a table of
CompositeData
records. - Throws:
ManagementException
-
getActivities
TabularData getActivities(int maxPerNode, String entityName, boolean includeRemoved) throws ManagementException, UnrecognizedResourceAdaptorEntityException
Return summary information about activities in the SLEE belonging to a specific resource adaptor entity.
The results are returned as
TabularData
where each entry is aCompositeData
containing summary information about a SLEE activity. Refer to Activity Search Results in the interface description for a description of theCompositeData
records returned by this method.This method is equivalent to invoking
getActivities(int, String, long, long, long, long, boolean)
, passing the parametersgetActivities(maxPerNode, entityName, -1, -1, -1, -1, includeRemoved);
- Parameters:
maxPerNode
- maximum number of entries to return from each node.entityName
- resource adaptor entity name. May benull
to return activities from all resource adaptor entities.includeRemoved
- boolean flag indicating if removed but not yet garbage collected activities should be included in the results.- Returns:
- activity information.
- Throws:
ManagementException
UnrecognizedResourceAdaptorEntityException
-
getActivities
TabularData getActivities(int maxPerNode, String entityName, long createdAfter, long createdBefore, long updatedAfter, long updatedBefore, boolean includeRemoved) throws ManagementException, UnrecognizedResourceAdaptorEntityException
Return summary information about active activities in the SLEE, with optional bounds on the owning resource adaptor entity, activity creation time, and last update time.
This method searches for activities belonging to a particular resource adaptor entity that were created during, or last updated during (meaning the last time an event was processed) a certain time period.
The results are returned as
TabularData
where each entry is aCompositeData
containing summary information about a SLEE activity. Refer to Activity Search Results in the interface description for a description of theCompositeData
records returned by this method.- Parameters:
maxPerNode
- maximum number of entries to return from each node.entityName
- resource adaptor entity name. May benull
to return activities from all resource adaptor entities.createdAfter
- if > 0, returns only activities created after timestamp.createdBefore
- if > 0, returns only activities created before timestamp.updatedAfter
- if > 0, returns only activities last updated after timestamp.updatedBefore
- if > 0, returns only activities last updated before timestamp.includeRemoved
- boolean flag indicating if removed but not yet garbage collected activities should be included in the results.- Returns:
- activity information.
- Throws:
ManagementException
UnrecognizedResourceAdaptorEntityException
-
getActivities
@Deprecated TabularData getActivities(int maxPerNode, String entityName, long createdAfter, long createdBefore, long updatedAfter, long updatedBefore, boolean includeRemoved, boolean includeNonResident) throws ManagementException, UnrecognizedResourceAdaptorEntityException
Deprecated.Support for scanning the key/value store for all non-resident activities has been removed. TheincludeNonResident
argument is now ignored with an assumed value offalse
, thus this method is now identical in behaviour togetActivities(int, String, long, long, long, long, boolean)
.Return a table of activities belonging to a resource adaptor entity, with optional bounds on activity creation time and last update time.
This method searches for activities belonging to a particular Resource Adaptor entity that were created during, or last updated during (meaning the last time an event was processed) a certain time period.
The results are returned as
TabularData
where each entry is aCompositeData
containing summary information about a SLEE activity. Refer to Activity Search Results in the interface description for a description of theCompositeData
records returned by this method.- Parameters:
maxPerNode
- maximum number of entries to return from each node.entityName
- resource Adaptor entity name. May benull
to return activities from all resource adaptor entities.createdAfter
- if > 0, returns only activities created after timestamp.createdBefore
- if > 0, returns only activities created before timestamp.updatedAfter
- if > 0, returns only activities last updated after timestamp.updatedBefore
- if > 0, returns only activities last updated before timestamp.includeRemoved
- boolean flag indicating if removed but not yet garbage collected activities should be included in the results.includeNonResident
- boolean flag indicating if activities not currently resident on any active cluster node should be included in the results. An example of a non-resident activity is one that was replicated via a key/value store whose owning node has left the cluster and the activity has not yet been adopted by any other node. This option is ignored if this housekeeping MBean is anode housekeeping MBean
rather than acluster housekeeping MBean
.- Returns:
- activity information.
- Throws:
ManagementException
UnrecognizedResourceAdaptorEntityException
- Since:
- Rhino 2.6.1
-
getRemovedActivities
TabularData getRemovedActivities(int maxPerNode, String entityName, long createdAfter, long createdBefore, long updatedAfter, long updatedBefore) throws ManagementException, UnrecognizedResourceAdaptorEntityException
Return summary information about removed but not yet garbage collected activities in the SLEE, with optional bounds on the owning resource adaptor entity, activity creation time, and last update time.
This method searches for activities belonging to a particular resource adaptor entity that were created during, or last updated during (meaning the time the activity was removed) a certain time period.
The results are returned as
TabularData
where each entry is aCompositeData
containing summary information about a SLEE activity. Refer to Activity Search Results in the interface description for a description of theCompositeData
records returned by this method.- Parameters:
maxPerNode
- maximum number of entries to return from each node.entityName
- resource adaptor entity name. May benull
to return activities from all resource adaptor entities.createdAfter
- if > 0, returns only activities created after timestamp.createdBefore
- if > 0, returns only activities created before timestamp.updatedAfter
- if > 0, returns only activities last updated after timestamp.updatedBefore
- if > 0, returns only activities last updated before timestamp.- Returns:
- activity information.
- Throws:
ManagementException
UnrecognizedResourceAdaptorEntityException
- Since:
- Rhino 2.6.2
-
getAttachedActivities
TabularData getAttachedActivities(int maxPerNode, ServiceID serviceID, SbbID sbbID, String sbbPKey) throws InvalidPKeyException, ManagementException, UnrecognizedServiceException, UnrecognizedSbbException, UnknownSbbEntityException
Return a table of activities attached to an SBB entity.
Returns a list of activities and basic activity information for activities that a particular SBB entity is currently attached to. Results are returned as a
TabularData
table of records. Refer to Attached Activities Search Results in the interface description for a description of theCompositeData
records returned.This method is equivalent to invoking
getAttachedActivities(int, ServiceID, SbbID, String, boolean)
, passing the parametersgetAttachedActivities(maxPerNode, serviceID, sbbID, sbbPKey, false);
.- Parameters:
maxPerNode
- maximum number of entries to return from each node.serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, javax.slee.ServiceID, javax.slee.SbbID, long, long)
)- Returns:
- activity information.
- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.
-
getAttachedActivities
TabularData getAttachedActivities(int maxPerNode, ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident) throws InvalidPKeyException, ManagementException, UnrecognizedServiceException, UnrecognizedSbbException, UnknownSbbEntityException
Return a table of activities attached to an SBB entity.
Returns a list of activities and basic activity information for activities that a particular SBB entity is currently attached to. Results are returned as a
TabularData
table of records. Refer to Attached Activities Search Results in the interface description for a description of theCompositeData
records returned. In-memory database state will be checked first for presence of the SBB entity. If the SBB entity not found there and thenonResident
argument istrue
, this method will also check non-resident SBB entities, such as those maintained externally by a key/value store, that are not currently owned by any active cluster node.- Parameters:
maxPerNode
- maximum number of entries to return from each node.serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, javax.slee.ServiceID, javax.slee.SbbID, long, long)
)nonResident
- boolean flag indicating if SBB entities not currently resident on any active cluster node should be checked for presence of the specified SBB entity.- Returns:
- activity information.
- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.- Since:
- Rhino 2.6.2
-
getSbbs
TabularData getSbbs(int maxPerNode, ServiceID serviceID) throws UnrecognizedServiceException, ManagementException
Return a table of SBB entities belonging to a Service.
This method searches for and returns a list of SBB entities belonging to a particular service and returns a
TabularData
table of summary information about each SBB entity found. For details on the row type for the returned data refer to SBB Entity Search Results in the interface description.This method is equivalent to invoking
getSbbs(int, ServiceID, SbbID, long, long)
, passing the parametersgetSbbs(maxPerNode, serviceID, null, -1, -1);
- Parameters:
maxPerNode
- maximum number of entries to return from each node.serviceID
- ServiceID of the Service component to search within.- Returns:
- a TabularData table of SBB information.
- Throws:
NullPointerException
- ifservice
isnull
.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.ManagementException
-
getSbbs
TabularData getSbbs(int maxPerNode, ServiceID serviceID, long createdAfter, long createdBefore) throws ManagementException, UnrecognizedServiceException
Return a table of SBB entities belonging to a Service
This method searches for and returns a list of SBB entities belonging to a particular service with a constraint on the time the SBB entity was created. Results are returned in a
TabularData
table. For details on the row type for the returned data refer to SBB Entity Search Results in the interface description.This method is equivalent to invoking
getSbbs(int, ServiceID, SbbID, long, long)
, passing the parametersgetSbbs(maxPerNode, serviceID, null, createdAfter, createdBefore);
- Parameters:
maxPerNode
- maximum number of entries to return from each node.serviceID
- ServiceID of the Service containing the SBB.createdAfter
- if > 0, returns only SBB entities created after timestamp.createdBefore
- if > 0, returns only SBB entities created before timestamp.- Returns:
- a TabularData table of SBB information.
- Throws:
NullPointerException
- ifservice
isnull
.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.ManagementException
- if a system failure occurs.
-
getSbbs
TabularData getSbbs(int maxPerNode, ServiceID serviceID, SbbID sbbType, long createdAfter, long createdBefore) throws ManagementException, UnrecognizedSbbException, UnrecognizedServiceException
Returns a table of SBB entities constrained by service component id, SBB component id and creation time
Searches within a service and SBB component type for SBB’s. Optionally a timeframe may be specified limiting the search to SBB’s created only during that time period. This method is useful for finding old, potentially 'stale' SBB entities. For details on the row type for the returned data refer to SBB Entity Search Results in the interface description.
- Parameters:
maxPerNode
- maximum number of entries to return from each node.serviceID
- ServiceID of the Service containing the SBB.sbbType
- SBB component ID of the type of SBB to search for.createdAfter
- if > 0, returns only SBB entities created after timestamp.createdBefore
- if > 0, returns only SBB entities created before timestamp.- Returns:
- SBB information.
- Throws:
NullPointerException
- ifservice
isnull
.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.ManagementException
- if a system failure occurs.
-
getSbbs
@Deprecated TabularData getSbbs(int maxPerNode, ServiceID serviceID, SbbID sbbType, long createdAfter, long createdBefore, boolean includeNonResident) throws ManagementException, UnrecognizedSbbException, UnrecognizedServiceException
Deprecated.Support for scanning the key/value store for all non-resident SBB entities has been removed. TheincludeNonResident
argument is now ignored with an assumed value offalse
, thus this method is now identical in behaviour togetSbbs(int, ServiceID, SbbID, long, long)
.Returns a table of SBB entities constrained by service component id, SBB component id and creation time
Searches within a service and SBB component type for SBB’s. Optionally a timeframe may be specified limiting the search to SBB’s created only during that time period. This method is useful for finding old, potentially 'stale' SBB entities. For details on the row type for the returned data refer to SBB Entity Search Results in the interface description.
- Parameters:
maxPerNode
- maximum number of entries to return from each node.serviceID
- ServiceID of the Service containing the SBB.sbbType
- SBB component ID of the type of SBB to search for.createdAfter
- if > 0, returns only SBB entities created after timestamp.createdBefore
- if > 0, returns only SBB entities created before timestamp.includeNonResident
- boolean flag indicating if SBBs not currently resident on any active cluster node should be included in the results. An example of a non-resident SBB is one that was replicated via a key/value store whose owning node has left the cluster and the SBB has not yet been adopted by any other node. This option is ignored if this housekeeping MBean is anode housekeeping MBean
rather than acluster housekeeping MBean
.- Returns:
- SBB information.
- Throws:
NullPointerException
- ifservice
isnull
.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.1
-
getTimers
TabularData getTimers(int maxPerNode) throws ManagementException
Find active SLEE timers
Returns a table containing JAIN SLEE Timer Facility timers and basic information about each timer.
For a description of the
CompositeData
result type returned by this method refer to Timer Search Results in the interface description.- Parameters:
maxPerNode
- maximum number of entries to return from each node.- Returns:
- timer information.
- Throws:
ManagementException
- if a system failure occurs.
-
getTimers
TabularData getTimers(int maxPerNode, String raEntity, long createdAfter, long createdBefore) throws ManagementException
Find active SLEE timers
Returns a table containing JAIN SLEE Timer Facility timers and basic information about each timer. The search can be limited to timers created within a particular time period.
For a description of the
CompositeData
result type returned by this method refer to Timer Search Results in the interface description.- Parameters:
maxPerNode
- maximum number of entries to return from each node.raEntity
- if not null only timers set on activities belonging to this RA entity will be returned.createdAfter
- if > 0, returns only timers created after timestamp.createdBefore
- if > 0, returns only timers created before timestamp.- Returns:
- timer information.
- Throws:
ManagementException
- if a system failure occurs.
-
getRemoteTimers
TabularData getRemoteTimers(int maxPerNode) throws ManagementException
Find remote SLEE timers.
Returns a table containing remote timers and basic information about each timer. This operation returns information about the remote timers that are armed on a node, not the timers that a node has requested to be armed remotely.
For a description of the
CompositeData
result type returned by this method refer to Remote Timer Search Results in the interface description.- Parameters:
maxPerNode
- maximum number of entries to return from each node.- Returns:
- remote timer information.
- Throws:
ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.2
-
getRemoteTimers
TabularData getRemoteTimers(int maxPerNode, String raEntity, long createdAfter, long createdBefore) throws ManagementException
Find remote SLEE timers.
Returns a table containing remote timers and basic information about each timer. This operation returns information about the remote timers that are armed on a node, not the timers that a node has requested to be armed remotely. The search can be limited to timers created within a particular time period.
For a description of the
CompositeData
result type returned by this method refer to Remote Timer Search Results in the interface description.- Parameters:
maxPerNode
- maximum number of entries to return from each node.raEntity
- if not null only timers set on activities belonging to this RA entity will be returned.createdAfter
- if > 0, returns only timers created after timestamp.createdBefore
- if > 0, returns only timers created before timestamp.- Returns:
- timer information.
- Throws:
ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.2
-
getBoundActivities
TabularData getBoundActivities(int maxPerNode) throws ManagementException
Find activity context naming facility bindings.
Returns a table containing JAIN SLEE Activity Context Naming facility bindings and basic information about each binding, including the name bound and the activities primary key.
For a description of the
CompositeData
result type returned by this method refer to Activity Context Binding Search Results in the interface description.- Parameters:
maxPerNode
- maximum number of entries to return from each node.- Returns:
- activity context naming bindings.
- Throws:
ManagementException
-
getBoundActivities
TabularData getBoundActivities(int maxPerNode, long createdAfter, long createdBefore) throws ManagementException
Find activity context naming facility bindings.
Returns a table containing JAIN SLEE Activity Context Naming facility bindings and basic information about each binding, including the name bound and the activities primary key. The search can be limited to bindings created within a particular time period.
For a description of the
CompositeData
result type returned by this method refer to Activity Context Binding Search Results in the interface description.- Parameters:
maxPerNode
- maximum number of entries to return from each node.createdAfter
- if > 0, returns only bindings created after timestamp.createdBefore
- if > 0, returns only bindings created before timestamp.- Returns:
- activity context naming bindings.
- Throws:
ManagementException
-
getActivityInfo
CompositeData getActivityInfo(String activityPKey, boolean showAllGenerations) throws ManagementException, InvalidPKeyException, UnknownActivityException
Get information about a SLEE activity.
This method returns detailed information about an activity contained within the SLEE. The activity to inspect is specified by primary key. Activity primary keys are returned by
getActivities(int, String, long, long, long, long, boolean)
andgetAttachedActivities(int, javax.slee.ServiceID, javax.slee.SbbID, String)
.For a description of the
CompositeData
result type returned by this method refer to Activity Information in the interface description.This method is equivalent to invoking
getActivityInfo(String, boolean, boolean)
, passing the parametersgetActivityInfo(activityPKey, showAllGenerations, false);
.- Parameters:
activityPKey
- activity primary key.- Returns:
- detailed activity information.
- Throws:
UnknownActivityException
- if no activity can be found with the specified primary key - may indicate that the activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the activity primary key is invalid.ManagementException
- if a system failure occurs.
-
getActivityInfo
CompositeData getActivityInfo(String activityPKey, boolean showAllGenerations, boolean nonResident) throws ManagementException, InvalidPKeyException, UnknownActivityException
Get information about a SLEE activity.
This method returns detailed information about an activity contained within the SLEE. The activity to inspect is specified by primary key. Activity primary keys are returned by the following operations:
For a description of the
CompositeData
result type returned by this method refer to Activity Information in the interface description.- Parameters:
activityPKey
- activity primary key.nonResident
- boolean flag that if true requests that if the activity state is not found in any currently active cluster node that external storage such as that maintained by a key/value store should be checked for the activity’s state.- Returns:
- detailed activity information.
- Throws:
UnknownActivityException
- if no activity can be found with the specified primary key - may indicate that the activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the activity primary key is invalid.ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.1
-
getSbbInfo
CompositeData getSbbInfo(ServiceID serviceID, SbbID sbbID, String sbbPKey) throws ManagementException, InvalidPKeyException, UnrecognizedSbbException, UnrecognizedServiceException, UnknownSbbEntityException
Return detailed information about the state of a particular SBB entity.
This method returns detailed information about an SBB entity contained within the SLEE. To locate the SBB entity to inspect the SBB entities service, SBB component ID and primary key are required. SBB entities primary keys are found using
getSbbs(int, javax.slee.ServiceID, javax.slee.SbbID, long, long)
.For a description of the
CompositeData
result type returned by this method refer to SBB Entity Information in the interface description.This method is equivalent to invoking
getSbbInfo(ServiceID, SbbID, String, boolean)
, passing the parametersgetSbbInfo(serviceID, sbbID, sbbPKey, false);
.- Parameters:
serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, ServiceID)
).- Returns:
- detailed SBB entity information.
- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.
-
getSbbInfo
CompositeData getSbbInfo(ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident) throws ManagementException, InvalidPKeyException, UnrecognizedSbbException, UnrecognizedServiceException, UnknownSbbEntityException
Return detailed information about the state of a particular SBB entity.
This method returns detailed information about an SBB entity contained within the SLEE. To locate the SBB entity to inspect the SBB entities service, SBB component ID and primary key are required. SBB entities primary keys are found using
getSbbs(int, javax.slee.ServiceID, javax.slee.SbbID, long, long)
. In-memory database state will be checked first for presence of the SBB entity. If the SBB entity not found there and thenonResident
argument istrue
, this method will also check non-resident SBB entities, such as those maintained externally by a key/value store, that are not currently owned by any active cluster node.For a description of the
CompositeData
result type returned by this method refer to SBB Entity Information in the interface description.- Parameters:
serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, ServiceID)
).nonResident
- boolean flag indicating if SBB entities not currently resident on any active cluster node should be checked for presence of the specified SBB entity.- Returns:
- detailed SBB entity information.
- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.- Since:
- Rhino 2.6.2
-
getSbbDiagnostics
CompositeData getSbbDiagnostics(ServiceID serviceID, SbbID sbbID, String sbbPKey) throws ManagementException, InvalidPKeyException, UnrecognizedSbbException, UnrecognizedServiceException, UnknownSbbEntityException
Return diagnostic information about the state of a particular SBB entity.
This method returns detailed information about an SBB entity contained within the SLEE. To locate the SBB entity to inspect the SBB entities service, SBB component ID and primary key are required. SBB entities primary keys are found using
getSbbs(int, javax.slee.ServiceID, javax.slee.SbbID, long, long)
.For a description of the
CompositeData
result type returned by this method refer to SBB Entity Diagnostic Information in the interface description.This method is equivalent to invoking
getSbbDiagnostics(ServiceID, SbbID, String, boolean)
, passing the parametersgetSbbDiagnostics(serviceID, sbbID, sbbPKey, false);
.- Parameters:
serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, ServiceID)
).- Returns:
- detailed SBB entity information.
- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.
-
getSbbDiagnostics
CompositeData getSbbDiagnostics(ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident) throws ManagementException, InvalidPKeyException, UnrecognizedSbbException, UnrecognizedServiceException, UnknownSbbEntityException
Return diagnostic information about the state of a particular SBB entity.
This method returns detailed information about an SBB entity contained within the SLEE. To locate the SBB entity to inspect the SBB entities service, SBB component ID and primary key are required. SBB entities primary keys are found using
getSbbs(int, javax.slee.ServiceID, javax.slee.SbbID, long, long)
. In-memory database state will be checked first for presence of the SBB entity. If the SBB entity not found there and thenonResident
argument istrue
, this method will also check non-resident SBB entities, such as those maintained externally by a key/value store, that are not currently owned by any active cluster node.For a description of the
CompositeData
result type returned by this method refer to SBB Entity Diagnostic Information in the interface description.- Parameters:
serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, ServiceID)
).nonResident
- boolean flag indicating if SBB entities not currently resident on any active cluster node should be checked for presence of the specified SBB entity.- Returns:
- detailed SBB entity information.
- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.- Since:
- Rhino 2.6.2
-
cancelTimer
void cancelTimer(String timerID) throws InvalidPKeyException, ManagementException, UnknownTimerException
Cancel a SLEE timer.
Caution: This method irrevocably removes SLEE application state.
This method requires the timer’s primary key, returned by either
getTimers(int, java.lang.String, long, long)
andgetActivityInfo(String, boolean, boolean)
.- Parameters:
timerID
- encoded timer id.- Throws:
UnknownTimerException
- if no timer can be found with the specified primary key - may indicate that the timer has expired or the underlying activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the timer primary key is invalid.ManagementException
- if a system failure occurs.
-
cancelRemoteTimer
void cancelRemoteTimer(String remoteTimerID) throws InvalidPKeyException, UnknownTimerException, ManagementException
Cancel a remote timer.
This method cancels a remotely armed timer. Cancelling a remote timer prevents the timer from triggering activity adoption by another node in the event that the target node of remote timer event callbacks fails. Cancelling a remote timer does not itself affect any associated local SLEE timer, ie. the local timer will still fire unless it is also cancelled (or it expires).
This method requires the remote timer’s primary key as returned by
getRemoteTimers(int, java.lang.String, long, long)
.- Parameters:
remoteTimerID
- encoded remote timer id.- Throws:
UnknownTimerException
- if no remote timer can be found with the specified primary key - may indicate that the timer has expired or the underlying activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the remote timer primary key is invalid.ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.2
-
getTimerInfo
CompositeData getTimerInfo(String timerID) throws InvalidPKeyException, ManagementException, UnknownTimerException
Get information about a SLEE timer.
This method requires the timer’s primary key, returned by either
getTimers(int, java.lang.String, long, long)
andgetActivityInfo(String, boolean, boolean)
.For a description of the
CompositeData
result type returned by this method refer to Timer Information in the interface description.- Parameters:
timerID
- encoded timer id.- Returns:
- detailed timer information.
- Throws:
UnknownTimerException
- if no timer can be found with the specified primary key - may indicate that the timer has expired or the underlying activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the timer primary key is invalid.ManagementException
- if a system failure occurs.
-
getRemoteTimerInfo
CompositeData getRemoteTimerInfo(String remoteTimerID) throws InvalidPKeyException, UnknownTimerException, ManagementException
Get information about a remote timer.
This method requires the remote timer’s primary key as returned by
getRemoteTimers(int, java.lang.String, long, long)
.For a description of the
CompositeData
result type returned by this method refer to Remote Timer Information in the interface description.- Parameters:
remoteTimerID
- encoded remote timer id.- Returns:
- detailed remote timer information.
- Throws:
UnknownTimerException
- if no remote timer can be found with the specified primary key - may indicate that the timer has expired or the underlying activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the remote timer primary key is invalid.ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.2
-
removeActivityBinding
void removeActivityBinding(String activityPKey, String name) throws ManagementException, InvalidPKeyException, UnknownActivityException, NameNotBoundException
Remove an activity context naming facility binding.
Caution: This method irrevocably removes application state.
Names bound in the activity context naming facility can be located using
getBoundActivities(int, long, long)
)- Parameters:
activityPKey
- the bound activity.name
- the bound name.- Throws:
UnknownActivityException
- if no activity can be found with the specified primary key - may indicate that the activity has already ended and all its SLEE state removed.NameNotBoundException
- if the name is not known to the activity context naming facility, or if the specified activity is not bound to it - may indicate that the name has already been unbound.InvalidPKeyException
- if the activity primary key is invalid.ManagementException
- if a system failure occurs.
-
removeActivityBinding
void removeActivityBinding(String activityPKey, String name, boolean nonResident) throws ManagementException, InvalidPKeyException, UnknownActivityException, NameNotBoundException
Remove an activity context naming facility binding.
Caution: This method irrevocably removes application state.
Names bound in the activity context naming facility can be located using
getBoundActivities(int, long, long)
)- Parameters:
activityPKey
- the bound activity.name
- the bound name.nonResident
- boolean flag indicating if activities not currently resident on any node in the cluster should be checked for the given name binding.- Throws:
UnknownActivityException
- if no activity can be found with the specified primary key - may indicate that the activity has already ended and all its SLEE state removed.NameNotBoundException
- if the name is not known to the activity context naming facility, or if the specified activity is not bound to it - may indicate that the name has already been unbound.InvalidPKeyException
- if the activity primary key is invalid.ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.2
-
removeSbb
void removeSbb(ServiceID serviceID, SbbID sbbID, String sbbPKey) throws UnrecognizedServiceException, UnrecognizedSbbException, InvalidPKeyException, ManagementException, UnknownSbbEntityException
Removes an SBB entity.
Caution: This method irrevocably removes application state.
This method forcibly removes stale or unwanted SBB’s from Rhino. If the SBB to be removed has child SBB’s these will also be removed. SBB entities can be found using the following operations:
- Parameters:
serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, javax.slee.ServiceID)
).- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.
-
removeSbb
void removeSbb(ServiceID serviceID, SbbID sbbID, String sbbPKey, boolean nonResident) throws UnrecognizedServiceException, UnrecognizedSbbException, InvalidPKeyException, UnknownSbbEntityException, ManagementException
Removes an SBB entity.
Caution: This method irrevocably removes application state.
This method forcibly removes stale or unwanted SBB’s from Rhino. If the SBB to be removed has child SBB’s these will also be removed. SBB entities can be found using the following operations:
Note that normally this method can only remove SBB entities for which the invoked Rhino node (ie. the instance of this MBean as returned by
RhinoHousekeepingMBean.getNodeHousekeeping(int)
) is the processing node. If thenonResident
argument istrue
, this method will also check non-resident SBB entities, such as those maintained externally by a key/value store, that are not currently owned by any active cluster node.- Parameters:
serviceID
- ServiceID of the Service containing the SBB.sbbID
- SbbID of the SBB’s component.sbbPKey
- primary key of the SBB (usually a value returned bygetSbbs(int, javax.slee.ServiceID)
).nonResident
- boolean flag indicating if SBB entities not currently resident on any active cluster node should be checked for presence of the specified SBB entity.- Throws:
InvalidPKeyException
- if the SBB primary key is invalid.UnrecognizedServiceException
- if the service ID doesn’t match any deployed service.UnrecognizedSbbException
- if the SBB component ID doesn’t match any SBB component belonging to the specified service.UnknownSbbEntityException
- if no SBB entity matching the specified primary key is found - may indicate that the SBB entity has already been removed by the SLEE.ManagementException
- if a system level failure occurs.- Since:
- Rhino 2.6.2
-
removeActivity
void removeActivity(String activityPKey) throws ManagementException, InvalidPKeyException, UnknownActivityException
Remove an activity.
Caution: This method irrevocably removes application state.
This method forcibly ends an activity in the SLEE and should be used with caution. Stale activities or activities that might be considered candidates for forced removal can be found using
getActivities(int, String, long, long, long, long, boolean)
.Note that Rhino’s own internal query liveness mechanism is sufficient for normal removal of stale activities. Removal of an activity using this method should only be required in the case of a resource adaptor or external resource error preventing Rhino’s query liveness from detecting that the activity is stale.
Note that this method can only remove activities for which the invoked Rhino node (ie. the instance of this MBean as returned by
RhinoHousekeepingMBean.getNodeHousekeeping(int)
) is the processing node. An activity’s processing node can be queried usinggetActivityInfo(String, boolean)
.This method is equivalent to invoking
removeActivity(String, boolean)
, passing the parametersremoveActivity(activityPKey, false);
.- Parameters:
activityPKey
- string encoded activity primary key.- Throws:
UnknownActivityException
- if no activity can be found with the specified primary key - may indicate that the activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the activity primary key is invalid.ManagementException
- if a system failure occurs.
-
removeActivity
void removeActivity(String activityPKey, boolean nonResident) throws ManagementException, InvalidPKeyException, UnknownActivityException
Remove an activity.
Caution: This method irrevocably removes application state.
This method forcibly ends an activity in the SLEE and should be used with caution. Stale activities or activities that might be considered candidates for forced removal can be found using
getActivities(int, String, long, long, long, long, boolean)
.Note that Rhino’s own internal query liveness mechanism is sufficient for normal removal of stale activities. Removal of an activity using this method should only be required in the case of a resource adaptor or external resource error preventing Rhino’s query liveness from detecting that the activity is stale.
Note that normally this method can only remove activities for which the invoked Rhino node (ie. the instance of this MBean as returned by
RhinoHousekeepingMBean.getNodeHousekeeping(int)
) is the processing node. An activity’s processing node can be queried usinggetActivityInfo(String, boolean, boolean)
. If thenonResident
argument istrue
, this method will also check non-resident activities, such as those maintained externally by a key/value store, that are not currently owned by any active cluster node.- Parameters:
activityPKey
- string encoded activity primary key.nonResident
- boolean flag indicating if activities not currently resident on any active cluster node should be checked for presence of the specified activity.- Throws:
UnknownActivityException
- if no activity can be found with the specified primary key - may indicate that the activity has already ended and all its SLEE state removed.InvalidPKeyException
- if the activity primary key is invalid.ManagementException
- if a system failure occurs.- Since:
- Rhino 2.6.1
-
getLongRunningTransactions
TabularData getLongRunningTransactions(int maxPerNode, int minAge) throws InvalidArgumentException, ManagementException
Return summary information about long-running transactions in the SLEE. Long running transaction can occur when a profile MBean is left in the read-write state for a prolonged period of time, a client-demarcated user transaction is left active for a prolonged period of time, or a particular management operation takes a long time to complete.
The results are returned as
TabularData
, where each entry is aCompositeData
containing summary information about a transaction. Refer to Long-running Transaction Search Results in the interface descriptor for a descriptor of theCompositeData
records returned by this method.- Parameters:
maxPerNode
- maximum number of transactions to return from each node.minAge
- minimum age, measured in seconds, of transactions to include in the return result. The minimum value for this argument is 30s.- Returns:
- transaction information as a table of
CompositeData
records. - Throws:
InvalidArgumentException
- inminAge
is less than30
.ManagementException
- if a system failure occurs.
-
rollbackLongRunningTransaction
void rollbackLongRunningTransaction(int nodeID, long transactionID) throws javax.transaction.InvalidTransactionException, ManagementException
Force rollback of a long-running transaction. The transaction must still be active and must have been started at least 30s ago.
- Parameters:
nodeID
- The node ID of the cluster member on which the transaction was created.transactionID
- the transaction ID of the transaction.- Throws:
javax.transaction.InvalidTransactionException
- if the specified transaction does not exist, is not in the ACTIVE or MARKED FOR ROLLBACK state, or is less than 30s in age.ManagementException
- if a system failure occurs.
-
getTransactionStateInfo
CompositeData getTransactionStateInfo(int nodeID, long transactionID) throws javax.transaction.InvalidTransactionException, ManagementException
Get information about a transaction. For details on the returned data refer to Transaction State Information in the interface description.
- Parameters:
nodeID
- The node ID of the cluster member on which the transaction was created.transactionID
- the transaction ID of the transaction.- Throws:
javax.transaction.InvalidTransactionException
- if the specified transaction does not exist.ManagementException
- if a system failure occurs.
-
initiateCleanup
void initiateCleanup(String raEntityName) throws UnrecognizedResourceAdaptorEntityException, ManagementException
Initiate a cleanup of activities that have been removed but not garbage collected.
- Parameters:
raEntityName
- Restrict the cleanup to this RA entity (optional).- Throws:
UnrecognizedResourceAdaptorEntityException
- if a resource adaptor entity with the specified name does not exist.ManagementException
- if a system failure occurs.
-
initiateGlobalCleanup
void initiateGlobalCleanup() throws ManagementException
Initiate a cleanup of all in-memory database and activity state. This includes:
-
all in-memory database instances
-
all activities in all namespaces that have been removed but not yet garbage collected.
- Throws:
ManagementException
- if a system failure occurs.- Since:
- Rhino 2.7.0
-
-
getNodesWithPerNodeActivationState
int[] getNodesWithPerNodeActivationState() throws ManagementException
Get the set of node IDs for which per-node desired state currently exists.
- Returns:
- the set of node IDs for which per-node desired state currently exists.
- Throws:
ManagementException
- if the node IDs could not be obtained due to a system-level failure.
-
hasPerNodeActivationState
boolean hasPerNodeActivationState() throws UnsupportedOperationException, ManagementException
Determine if this node has any per-node desired state in existence.
- Returns:
true
if this node has any per-node desired state,false
otherwise.- Throws:
UnsupportedOperationException
- if this method is invoked on an instance of aNodeHousekeepingMBean
created for the cluster rather than a single node.ManagementException
- if the presence of per-node desired state could not be determined due to a system-level failure.
-
copyPerNodeActivationState
boolean copyPerNodeActivationState(int targetNodeID) throws UnsupportedOperationException, InvalidArgumentException, InvalidStateException, ManagementException
Copy the current per-node desired state of services, resource adaptor entities, and the SLEE from this node to the specified target node. This will overwrite the current per-node settings of the target node, and will trigger convergence towards the new desired state if it differs from the current actual state. This will also delete any per-node state from the target which is not present on this node.
- Parameters:
targetNodeID
- the node ID of the node to copy state to.- Returns:
true
if per-node activation state changed for the target node,false
if the target node already had the same per-node activation state.- Throws:
UnsupportedOperationException
- if this method is invoked on an instance of aNodeHousekeepingMBean
created for the cluster rather than a single node.InvalidArgumentException
- iftargetNodeID
is an invalid node ID.InvalidStateException
- no longer thrown as of Rhino 3.0.0ManagementException
- if the per-node activation state cannot be copied due to a system-level failure.
-
removePerNodeActivationState
boolean removePerNodeActivationState() throws UnsupportedOperationException, InvalidStateException, ManagementException
Remove all per-node desired state for services, resource adaptor entities, and the SLEE from this node.
- Returns:
true
if per-node desired state was found and removed,false
if no per-node desired state was found for this node.- Throws:
UnsupportedOperationException
- if this method is invoked on an instance of aNodeHousekeepingMBean
created for the cluster rather than a single node.InvalidStateException
- iftargetNodeID
is currently a member of the cluster.ManagementException
- if the per-node desired state cannot be removed due to a system-level failure.
-
getDesiredStates
String getDesiredStates() throws ManagementException
Get a summary report of all default and per-node desired states set for services, resource adaptor entities, and the SLEE.
This method returns a JSON-formatted string that reports the default desired state set for every stateful entity. The report also includes information on any per-node desired state where it has been set, regardless of whether or not the target node is a current cluster member.
- Returns:
- a JSON-formatted string reporting the current default and per-node desired states.
- Throws:
ManagementException
- if the current state cannot be determined due to a system-level error.- Since:
- Rhino 3.0.0
-
getEventRouterThreadState
TabularData getEventRouterThreadState(boolean includeIdleThreads) throws ManagementException
Retrieve the current status of all event router threads.
The returned table contains a breakdown of the current task of each event router thread at approximately the same point in time. Event router thread states are read concurrently without interrupting event processing so the result is not guaranteed to be an accurate point in time snapshot only an approximation.
For details on the row type for the returned data refer to Event Router State Results in the interface description.
- Parameters:
includeIdleThreads
- if true even idle threads will be included in the result- Returns:
- event router thread state as a table of
CompositeData
records - Throws:
ManagementException
- if event router state cannot be read because of a system level failure
-
getLocalMemDBStripingNodeConfig
TabularData getLocalMemDBStripingNodeConfig() throws ManagementException
Returns the current MemDB striping configuration for local MemDB instances on this node.
The striping config is returned in
TabularData
format - one row is returned per local MemDB instance. Each row contains the following information:Field Open Type Description memdb-resource
String
Memdb resource name
stripe-count
Integer
The stripe count
- Returns:
TabularData
containing node striping configuration information.- Throws:
ManagementException
- if an internal error occurs.
-
-