org.hibernate

Interface Transaction

All Known Implementing Classes:

TransactionImpl

public interface Transaction

Defines the contract for abstracting applications from the configured underlying means of transaction management. Allows the application to define units of work, while maintaining abstraction from the underlying transaction implementation (eg. JTA, JDBC).

A transaction is associated with a Session and is usually initiated by a call to SharedSessionContract.beginTransaction(). A single session might span multiple transactions since the notion of a session (a conversation between the application and the datastore) is of coarser granularity than the notion of a transaction. However, it is intended that there be at most one uncommitted transaction associated with a particular Session at any time.

Implementers are not intended to be thread-safe.

Author:

Anton van Straaten, Steve Ebersole

Method Summary

Modifier and Type	Method and Description
void	begin() Begin this transaction.
void	commit() Commit this transaction.
TransactionStatus	getStatus() Get the current local status of this transaction.
int	getTimeout() Retrieve the transaction timeout set for this transaction.
void	markRollbackOnly() Make a best effort to mark the underlying transaction for rollback only.
void	registerSynchronization(Synchronization synchronization) Register a user synchronization callback for this transaction.
void	rollback() Rollback this transaction.
void	setTimeout(int seconds) Set the transaction timeout for any transaction started by a subsequent call to begin() on this instance.

Method Detail

begin

void begin()

Begin this transaction. No-op if the transaction has already been begun. Note that this is not necessarily symmetrical since usually multiple calls to commit() or rollback() will error.

Throws:

HibernateException - Indicates a problem beginning the transaction.

commit

void commit()

Commit this transaction. This might entail a number of things depending on the context:

• If the underlying transaction was initiated from this Transaction the Session will be flushed, unless the Session is in FlushMode.MANUAL FlushMode.
• If the underlying transaction was initiated from this Transaction, commit the underlying transaction.
• Coordinate various callbacks

Throws:

HibernateException - Indicates a problem committing the transaction.

rollback

void rollback()

Rollback this transaction. Either rolls back the underlying transaction or ensures it cannot later commit (depending on the actual underlying strategy).

Throws:

HibernateException - Indicates a problem rolling back the transaction.

getStatus

TransactionStatus getStatus()

Get the current local status of this transaction.

This only accounts for the local view of the transaction status. In other words it does not check the status of the actual underlying transaction.

Returns:

The current local status.

registerSynchronization

void registerSynchronization(Synchronization synchronization)
                      throws HibernateException

Register a user synchronization callback for this transaction.

Parameters:

synchronization - The Synchronization callback to register.

Throws:

HibernateException - Indicates a problem registering the synchronization.

setTimeout

void setTimeout(int seconds)

Set the transaction timeout for any transaction started by a subsequent call to begin() on this instance.

Parameters:

seconds - The number of seconds before a timeout.

getTimeout

int getTimeout()

Retrieve the transaction timeout set for this transaction. A negative indicates no timeout has been set.

Returns:

The timeout, in seconds.

markRollbackOnly

void markRollbackOnly()

Make a best effort to mark the underlying transaction for rollback only.