WebSphere:*,type=SIBMessagingEngine
MBean SIBMessagingEngine
Management interface for the SIB Messaging Engine component
Attributes inherited from MBean StatisticsProvider |
stats |
Attributes inherited from MBean EventProvider |
eventTypes |
Operation Summary | |
java.lang.Long | getDepth( Get the number of messages currently on the temporaryQueuePoint on ME |
boolean | isStarted() Returns whether the Messaging Engine is in the started state. |
java.lang.String | state() Returns the state of the Messaging Engine. |
java.lang.String | stateExtended() Returns the state of the Messaging Engine |
void | start() Starts a stopped or inactive Messaging Engine |
void | start( Starts a stopped or inactive Messaging Engine with the specified start mode. |
void | stop() Stops a running Messaging Engine using the default stop mode of immediate |
void | stop( Stops a running Messaging Engine with the specified stop mode. |
com.ibm.websphere.sib.admin.SIBQueuePoint[] | listQueuePoints() List all QueuePoints localized to this MessagingEngine |
com.ibm.websphere.sib.admin.SIBQueuePoint | getQueuePoint( Get information relating to a QueuePoint localized to this Messaging Engine |
com.ibm.websphere.sib.admin.SIBQueuedMessage[] | getQueuePointMessages( List information on all messages localized to a specific QueuePoint |
com.ibm.websphere.sib.admin.SIBQueuedMessage[] | getQueuePointMessages( List information on all messages localized to a specific QueuePoint |
com.ibm.websphere.sib.admin.SIBQueuedMessage | getQueuePointMessage( Get information on a specific message on a specific QueuePoint |
com.ibm.websphere.sib.admin.SIBQueuedMessageDetail | getQueuePointMessageDetail( Get detailed information on a specific message on a specific QueuePoint |
com.ibm.websphere.sib.admin.SIBQueuedMessageDetail | getQueuePointMessageDetail( Get detailed information on a specific message on a specific QueuePoint |
byte[] | getQueuePointMessageData( Return data from a specific message on a specific QueuePoint |
com.ibm.wsspi.hamanager.GroupName | getHAGroupName() Returns the GroupName of the HA Group the Messaging Engine is in. |
java.lang.String | getHealth() Returns the current Health of the Messaging Engine, as a String. |
void | injectFault( Injects a simulated fault into the Messaging Engine, causing it to fail the next health check. |
void | dump( Invoke the Messaging Engine diagnostic dump |
java.util.Collection | getPreparedTransactions() List in-doubt transactions |
void | commitPreparedTransaction( Commit the given transaction by xid |
void | rollbackPreparedTransaction( Rollback the given transaction by xid |
void | disableDataStoreLock( This method has no effect on a messaging engine. |
void | resetDestination( Resets a corrupt destination such that on restart, it is deleted and recreated. |
Notification Summary | |
SIB.messaging.engine.start An ME is being started. | |
SIB.messaging.engine.stop An ME is being stopped. | |
SIB.security.not.authenticated The ME could not authenticate a user. | |
SIB.security.not.authorized The ME denied a user authorization to access a resource. | |
SIB.communications.connection.start An intra-bus ME to ME connection has been started. | |
SIB.communications.connection.stop An intra-bus ME to ME connection has been stopped. | |
SIB.message.exceptioned The ME exceptioned a message that could not be delivered to the intended destination. | |
SIB.client.connection.start A remote client has connected to the ME. | |
SIB.client.connection.stop A remote client has disconnected from the ME. | |
SIB.messaging.engine.starting An ME is being started. | |
SIB.messaging.engine.stopping An ME is being stopped. | |
SIB.messaging.engine.failed An ME start or stop has failed. |
Notifications inherited from MBean Stateful |
j2ee.state.starting , j2ee.state.running , j2ee.state.stopping , j2ee.state.stopped , j2ee.state.failed |
Attributes inherited from MBean EventProvider |
j2ee.attribute.changed |
Operation Detail |
public java.lang.Long getDepth(java.lang.String id
)
id
-
The ID of the QueuePoint derived from ME
public boolean isStarted()
public java.lang.String state()
public java.lang.String stateExtended()
public void start()
public void start(java.lang.String mode
)
mode
-
Start mode. Valid values are 'DEFAULT' (the default) and 'FLUSH'.
public void stop()
public void stop(java.lang.String mode
)
mode
-
Stop mode. Valid values are 'IMMEDIATE' (the default) and 'FORCE'.
public com.ibm.websphere.sib.admin.SIBQueuePoint[] listQueuePoints()
public com.ibm.websphere.sib.admin.SIBQueuePoint getQueuePoint(java.lang.String id
)
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint class
public com.ibm.websphere.sib.admin.SIBQueuedMessage[] getQueuePointMessages(java.lang.String id
)
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint class
public com.ibm.websphere.sib.admin.SIBQueuedMessage[] getQueuePointMessages(java.lang.String id,
java.lang.Integer toIndex,
java.lang.Integer fromIndex,
java.lang.Integer totalMessagesPerPage
)
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint classtoIndex
-
fromIndexfromIndex
-
toIndextotalMessagesPerPage
-
totalMessagesPerPage
public com.ibm.websphere.sib.admin.SIBQueuedMessage getQueuePointMessage(java.lang.String id,
java.lang.String messageId
)
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint classmessageId
-
The ID of the Message as derived from the SIBQueuedMessage class
public com.ibm.websphere.sib.admin.SIBQueuedMessageDetail getQueuePointMessageDetail(java.lang.String qpId,
java.lang.String messageId
)
qpId
-
The ID of the QueuePoint as derived from the SIBQueuePoint classmessageId
-
The ID of the Message as derived from the SIBQueuedMessage class
public com.ibm.websphere.sib.admin.SIBQueuedMessageDetail getQueuePointMessageDetail(java.lang.String qpId,
java.lang.String messageId,
java.util.Locale locale
)
qpId
-
The ID of the QueuePoint as derived from the SIBQueuePoint classmessageId
-
The ID of the Message as derived from the SIBQueuedMessage classlocale
-
The locale to render exception reason messages for the SIBQueuedMessage
public byte[] getQueuePointMessageData(java.lang.String qpId,
java.lang.String messageId,
java.lang.Integer size
)
qpId
-
The ID of the QueuePoint as derived from the SIBQueuePoint classmessageId
-
The ID of the Message as derived from the SIBQueuedMessage classsize
-
The number of bytes to return
public com.ibm.wsspi.hamanager.GroupName getHAGroupName()
public java.lang.String getHealth()
public void injectFault(java.lang.String severity
)
severity
-
Error severity (LocalError or GlobalError)
public void dump(java.lang.String dumpSpec
)
dumpSpec
-
The dump specification string
public java.util.Collection getPreparedTransactions()
public void commitPreparedTransaction(java.lang.String xid
)
xid
-
The xid of the transaction
public void rollbackPreparedTransaction(java.lang.String xid
)
xid
-
The xid of the transaction
public void disableDataStoreLock(java.lang.Long period
)
period
-
The time period to disable locking for in milliseconds.
public void resetDestination(java.lang.String identifier
)
identifier
-
The name, or identifier, of the destinationNotification Detail |