javax.transaction

Interface Transaction

All Known Implementing Classes:

WebSphereExtendedJtaPlatform.TransactionManagerAdapter.TransactionAdapter

public interface Transaction

The Transaction interface allows operations to be performed on transactions.

Version:

$Revision$

Method Summary

Methods

Modifier and Type	Method and Description
void	commit() Attempt to commit this transaction.
boolean	delistResource(XAResource xaRes, int flag) Delist an XA resource from this transaction.
boolean	enlistResource(XAResource xaRes) Enlist an XA resource with this transaction.
int	getStatus() Get the status of the transaction.
void	registerSynchronization(Synchronization sync) Register a Synchronization callback with this transaction.
void	rollback() Rolls back this transaction.
void	setRollbackOnly() Mark the transaction so that the only possible outcome is a rollback.

Method Detail

commit

void commit()
            throws RollbackException,
                   HeuristicMixedException,
                   HeuristicRollbackException,
                   SecurityException,
                   SystemException

Attempt to commit this transaction.

Throws:

RollbackException - If the transaction was marked for rollback only, the transaction is rolled back and this exception is thrown.

SystemException - If the transaction service fails in an unexpected way.

HeuristicMixedException - If a heuristic decision was made and some some parts of the transaction have been committed while other parts have been rolled back.

HeuristicRollbackException - If a heuristic decision to roll back the transaction was made.

SecurityException - If the caller is not allowed to commit this transaction.

rollback

void rollback()
              throws IllegalStateException,
                     SystemException

Rolls back this transaction.

Throws:

IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the transaction is no longer active, or because it is in the prepared state.

SystemException - If the transaction service fails in an unexpected way.

setRollbackOnly

void setRollbackOnly()
                     throws IllegalStateException,
                            SystemException

Mark the transaction so that the only possible outcome is a rollback.

Throws:

IllegalStateException - If the transaction is not in an active state.

SystemException - If the transaction service fails in an unexpected way.

getStatus

int getStatus()
              throws SystemException

Get the status of the transaction.

Returns:

The status of the transaction. This is one of the Status constants.

Throws:

SystemException - If the transaction service fails in an unexpected way.

enlistResource

boolean enlistResource(XAResource xaRes)
                       throws RollbackException,
                              IllegalStateException,
                              SystemException

Enlist an XA resource with this transaction.

Returns:

true if the resource could be enlisted with this transaction, otherwise false.

Throws:

RollbackException - If the transaction is marked for rollback only.

IllegalStateException - If the transaction is in a state where resources cannot be enlisted. This could be because the transaction is no longer active, or because it is in the prepared state.

SystemException - If the transaction service fails in an unexpected way.

delistResource

boolean delistResource(XAResource xaRes,
                     int flag)
                       throws IllegalStateException,
                              SystemException

Delist an XA resource from this transaction.

Returns:

true if the resource could be delisted from this transaction, otherwise false.

Throws:

IllegalStateException - If the transaction is in a state where resources cannot be delisted. This could be because the transaction is no longer active.

SystemException - If the transaction service fails in an unexpected way.

registerSynchronization

void registerSynchronization(Synchronization sync)
                             throws RollbackException,
                                    IllegalStateException,
                                    SystemException

Register a Synchronization callback with this transaction.

Throws:

RollbackException - If the transaction is marked for rollback only.

IllegalStateException - If the transaction is in a state where Synchronization callbacks cannot be registered. This could be because the transaction is no longer active, or because it is in the prepared state.

SystemException - If the transaction service fails in an unexpected way.