public interface

Transaction

org.hibernate.Transaction
Known Indirect Subclasses

Class Overview

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 instantiated by a call to Session.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.

Implementors are not intended to be threadsafe.

Summary

Public Methods
abstract void begin()
Begin a new transaction.
abstract void commit()
Flush the associated Session and end the unit of work (unless we are in MANUAL.
abstract boolean isActive()
Is this transaction still active?

Again, this only returns information in relation to the local transaction, not the actual underlying transaction.

abstract void registerSynchronization(Synchronization synchronization)
Register a user synchronization callback for this transaction.
abstract void rollback()
Force the underlying transaction to roll back.
abstract void setTimeout(int seconds)
Set the transaction timeout for any transaction started by a subsequent call to begin() on this instance.
abstract boolean wasCommitted()
Check if this transaction was successfully committed.
abstract boolean wasRolledBack()
Was this transaction rolled back or set to rollback only?

This only accounts for actions initiated from this local transaction.

Public Methods

public abstract void begin ()

Begin a new transaction.

public abstract void commit ()

Flush the associated Session and end the unit of work (unless we are in MANUAL.

This method will commit the underlying transaction if and only if the underlying transaction was initiated by this object.

public abstract boolean isActive ()

Is this transaction still active?

Again, this only returns information in relation to the local transaction, not the actual underlying transaction.

Returns
  • boolean Treu if this local transaction is still active.

public abstract void registerSynchronization (Synchronization synchronization)

Register a user synchronization callback for this transaction.

Parameters
synchronization The Synchronization callback to register.

public abstract void rollback ()

Force the underlying transaction to roll back.

public abstract 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.

public abstract boolean wasCommitted ()

Check if this transaction was successfully committed.

This method could return false even after successful invocation of commit(). As an example, JTA based strategies no-op on commit() calls if they did not start the transaction; in that case, they also report wasCommitted() as false.

Returns
  • boolean True if the transaction was (unequivocally) committed via this local transaction; false otherwise.

public abstract boolean wasRolledBack ()

Was this transaction rolled back or set to rollback only?

This only accounts for actions initiated from this local transaction. If, for example, the underlying transaction is forced to rollback via some other means, this method still reports false because the rollback was not initiated from here.

Returns
  • boolean True if the transaction was rolled back via this local transaction; false otherwise.