com.ibm.websphere.messaging.mbean
Interface MessagingEngineMBean


@MXBean
public interface MessagingEngineMBean

The MessagingEngineMBean is enabled by the wasJmsServer feature. This MBean provides an interface to query the runtime information of the messaging engine defined in the configuration.

JMX clients should use the ObjectName of this MBean to query it.
Partial Object Name: WebSphere:feature=wasJmsServer, type=MessagingEngine,name=*
where name is unique for each messaging engine and is equal to the name of the messaging engine defined in configuration.


Method Summary
 void commitPreparedTransaction(java.lang.String xid)
          Commit the given transaction.
 void dump(java.lang.String dumpSpec)
          Request the receiver to dump its xml representation.The dump file is created in the current server directory
 java.lang.String getName()
          Returns the name of the current messaging engine.
 java.lang.String[] listPreparedTransactions()
          Obtain a list of XIDs which are in-doubt.
 void resetDestination(java.lang.String name)
          Resets a corrupt destination such that on restart, it is deleted and recreated.
 void rollbackPreparedTransaction(java.lang.String xid)
          Rollback the given transaction.
 java.lang.String state()
          Return the state of the Messaging Engine.
 

Method Detail

getName

java.lang.String getName()
Returns the name of the current messaging engine. Please note that it is not possible to rename a messaging engine instance.

Returns:
Name of the Messaging Engine

state

java.lang.String state()
Return the state of the Messaging Engine.

Returns:
State of the Messaging Engine

resetDestination

void resetDestination(java.lang.String name)
                      throws java.lang.Exception
Resets a corrupt destination such that on restart, it is deleted and recreated.

Parameters:
Name - The name of the destination on the bus
Throws:
java.lang.Exception

dump

void dump(java.lang.String dumpSpec)
Request the receiver to dump its xml representation.The dump file is created in the current server directory

Parameters:
dumpSpec - The dump specification string, eg. "com.ibm.ws.sib.msgstore.*:com.ibm..."

listPreparedTransactions

java.lang.String[] listPreparedTransactions()
Obtain a list of XIDs which are in-doubt. Part of MBean interface for resolving in-doubt transactions in Message Store.

Returns:
XIDs as array of strings

commitPreparedTransaction

void commitPreparedTransaction(java.lang.String xid)
                               throws java.lang.Exception
Commit the given transaction. Part of MBean interface for resolving in-doubt transactions in Message Store.

Parameters:
xid - a string representing the xid of the transaction to be committed.
Throws:
java.lang.Exception

rollbackPreparedTransaction

void rollbackPreparedTransaction(java.lang.String xid)
                                 throws java.lang.Exception
Rollback the given transaction. Part of MBean interface for resolving in-doubt transactions in Message Store.

Parameters:
xid - a string representing the xid of the transaction to be rolled back.
Throws:
java.lang.Exception