com.metamatrix.server.admin.api
Interface TransactionAdminAPI

All Superinterfaces:

java.io.Serializable, SubSystemAdminAPI

All Known Implementing Classes:

TransactionAdminAPIImpl

public interface TransactionAdminAPI
extends SubSystemAdminAPI

Method Summary

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

Method Detail

getAllTransactions

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

Return all transactions that are in the system.

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

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

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

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

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.

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