JavaEE API 8.0.1 · javax.transaction.Transaction

Method Summary

Modifier and Type	Method and Description
public void	commit() Complete the transaction represented by this Transaction object.
public boolean	Returns: true if the resource was delisted successfully; otherwise false. delistResource(XAResource The XAResource object associated with the resource (connection). xaRes, int One of the values of TMSUCCESS, TMSUSPEND, or TMFAIL. flag) Disassociate the resource specified from the transaction associated with the target Transaction object.
public boolean	Returns: true if the resource was enlisted successfully; otherwise false. enlistResource(XAResource The XAResource object associated with the resource (connection). xaRes) Enlist the resource specified with the transaction associated with the target Transaction object.
public int	Returns: The transaction status. If no transaction is associated with the target object, this method returns the Status.NoTransaction value. getStatus() Obtain the status of the transaction associated with the target Transaction object.
public void	registerSynchronization(Synchronization The Synchronization object for the transaction associated with the target object. sync) Register a synchronization object for the transaction currently associated with the target object.
public void	rollback() Rollback the transaction represented by this Transaction object.
public void	setRollbackOnly() Modify the transaction associated with the target object such that the only possible outcome of the transaction is to roll back the transaction.

Method Detail

commit	back to summary
public void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException, IllegalStateException, SystemException Complete the transaction represented by this Transaction object. Exceptions RollbackException: Thrown to indicate that the transaction has been rolled back rather than committed. HeuristicMixedException: Thrown to indicate that a heuristic decision was made and that some relevant updates have been committed while others have been rolled back. HeuristicRollbackException: Thrown to indicate that a heuristic decision was made and that all relevant updates have been rolled back. SecurityException: Thrown to indicate that the thread is not allowed to commit the transaction. IllegalStateException: Thrown if the transaction in the target object is inactive. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

commit

back to summary

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

Complete the transaction represented by this Transaction object.

Exceptions

RollbackException:: Thrown to indicate that the transaction has been rolled back rather than committed.
HeuristicMixedException:: Thrown to indicate that a heuristic decision was made and that some relevant updates have been committed while others have been rolled back.
HeuristicRollbackException:: Thrown to indicate that a heuristic decision was made and that all relevant updates have been rolled back.
SecurityException:: Thrown to indicate that the thread is not allowed to commit the transaction.
IllegalStateException:: Thrown if the transaction in the target object is inactive.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

delistResource	back to summary
public boolean delistResource(XAResource xaRes, int flag) throws IllegalStateException, SystemException Disassociate the resource specified from the transaction associated with the target Transaction object. Parameters xaRes:XAResource The XAResource object associated with the resource (connection). flag:int One of the values of TMSUCCESS, TMSUSPEND, or TMFAIL. Returns:boolean true if the resource was delisted successfully; otherwise false. Exceptions IllegalStateException: Thrown if the transaction in the target object is inactive. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

delistResource

back to summary

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

Disassociate the resource specified from the transaction associated with the target Transaction object.

Parameters

xaRes:XAResource: The XAResource object associated with the resource (connection).
flag:int: One of the values of TMSUCCESS, TMSUSPEND, or TMFAIL.

Returns:boolean

true if the resource was delisted successfully; otherwise false.

Exceptions

IllegalStateException:: Thrown if the transaction in the target object is inactive.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

enlistResource	back to summary
public boolean enlistResource(XAResource xaRes) throws RollbackException, IllegalStateException, SystemException Enlist the resource specified with the transaction associated with the target Transaction object. Parameters xaRes:XAResource The XAResource object associated with the resource (connection). Returns:boolean true if the resource was enlisted successfully; otherwise false. Exceptions RollbackException: Thrown to indicate that the transaction has been marked for rollback only. IllegalStateException: Thrown if the transaction in the target object is in the prepared state or the transaction is inactive. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

enlistResource

back to summary

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

Enlist the resource specified with the transaction associated with the target Transaction object.

Parameters

xaRes:XAResource: The XAResource object associated with the resource (connection).

Returns:boolean

true if the resource was enlisted successfully; otherwise false.

Exceptions

RollbackException:: Thrown to indicate that the transaction has been marked for rollback only.
IllegalStateException:: Thrown if the transaction in the target object is in the prepared state or the transaction is inactive.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

getStatus	back to summary
public int getStatus() throws SystemException Obtain the status of the transaction associated with the target Transaction object. Returns:int The transaction status. If no transaction is associated with the target object, this method returns the Status.NoTransaction value. Exceptions SystemException: Thrown if the transaction manager encounters an unexpected error condition.

getStatus

back to summary

public int getStatus() throws SystemException

Obtain the status of the transaction associated with the target Transaction object.

Returns:int

The transaction status. If no transaction is associated with the target object, this method returns the Status.NoTransaction value.

Exceptions

SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

registerSynchronization	back to summary
public void registerSynchronization(Synchronization sync) throws RollbackException, IllegalStateException, SystemException Register a synchronization object for the transaction currently associated with the target object. The transction manager invokes the beforeCompletion method prior to starting the two-phase transaction commit process. After the transaction is completed, the transaction manager invokes the afterCompletion method. Parameters sync:Synchronization The Synchronization object for the transaction associated with the target object. Exceptions RollbackException: Thrown to indicate that the transaction has been marked for rollback only. IllegalStateException: Thrown if the transaction in the target object is in the prepared state or the transaction is inactive. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

registerSynchronization

back to summary

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

Register a synchronization object for the transaction currently associated with the target object. The transction manager invokes the beforeCompletion method prior to starting the two-phase transaction commit process. After the transaction is completed, the transaction manager invokes the afterCompletion method.

Parameters

sync:Synchronization: The Synchronization object for the transaction associated with the target object.

Exceptions

RollbackException:: Thrown to indicate that the transaction has been marked for rollback only.
IllegalStateException:: Thrown if the transaction in the target object is in the prepared state or the transaction is inactive.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

rollback	back to summary
public void rollback() throws IllegalStateException, SystemException Rollback the transaction represented by this Transaction object. Exceptions IllegalStateException: Thrown if the transaction in the target object is in the prepared state or the transaction is inactive. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

rollback

back to summary

public void rollback() throws IllegalStateException, SystemException

Rollback the transaction represented by this Transaction object.

Exceptions

IllegalStateException:: Thrown if the transaction in the target object is in the prepared state or the transaction is inactive.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

setRollbackOnly	back to summary
public void setRollbackOnly() throws IllegalStateException, SystemException Modify the transaction associated with the target object such that the only possible outcome of the transaction is to roll back the transaction. Exceptions IllegalStateException: Thrown if the target object is not associated with any transaction. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

setRollbackOnly

back to summary

public void setRollbackOnly() throws IllegalStateException, SystemException

Modify the transaction associated with the target object such that the only possible outcome of the transaction is to roll back the transaction.

Exceptions

IllegalStateException:: Thrown if the target object is not associated with any transaction.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

public Interface Transaction

Method Summary

Method Detail