com.metamatrix.server.admin.apiimpl
Class TransactionAdminAPIImpl

java.lang.Object
  com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl
      com.metamatrix.server.admin.apiimpl.TransactionAdminAPIImpl

All Implemented Interfaces:

SubSystemAdminAPI, TransactionAdminAPI, java.io.Serializable

public class TransactionAdminAPIImpl
extends SubSystemAdminAPIImpl
implements TransactionAdminAPI

See Also:

Serialized Form

Method Summary

java.util.Collection	getAllTransactions() Return all transactions that are in the system.
static TransactionAdminAPI	getInstance()
void	terminateAllTransactions(MetaMatrixSessionID userSessionID) Terminate all transactions for the user session.
void	terminateTransaction(TransactionID transactionID) Terminate a transactions.

Methods inherited from class com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl

getSessionID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static TransactionAdminAPI getInstance()
                                       throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

getAllTransactions

public java.util.Collection getAllTransactions()
                                        throws AuthorizationException,
                                               InvalidSessionException,
                                               MetaMatrixComponentException

Return all transactions that are in the system.

Specified by:

getAllTransactions in interface TransactionAdminAPI

Returns:

a collection of ServerTransaction objects.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

terminateTransaction

public void terminateTransaction(TransactionID transactionID)
                          throws AuthorizationException,
                                 InvalidSessionException,
                                 XATransactionException,
                                 MetaMatrixComponentException

Terminate a transactions. If status == STATUS_ACTIVE or STATUS_MARKED_ROLLBACK, rollback transaction. Else, set status to STATUS_ROLLEDBACK.

Specified by:

terminateTransaction in interface TransactionAdminAPI

Parameters:

transactionID - ID of the transaction to be rolledback.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

com.metamatrix.common.xa.InvalidTransactionIDException - if the Transaction does not exist.

MetaMatrixComponentException - if an error occurred in communicating with a component.

XATransactionException

terminateAllTransactions

public void terminateAllTransactions(MetaMatrixSessionID userSessionID)
                              throws AuthorizationException,
                                     InvalidSessionException,
                                     MultipleException,
                                     MetaMatrixComponentException

Terminate all transactions for the user session. If status == STATUS_ACTIVE or STATUS_MARKED_ROLLBACK, rollback transaction. Else, set status to STATUS_ROLLEDBACK.

Specified by:

terminateAllTransactions in interface TransactionAdminAPI

Parameters:

userSessionID - the primary identifier for the user account.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

MultipleException