org.hibernate.resource.transaction

Interface TransactionCoordinator

All Known Implementing Classes:

JdbcResourceLocalTransactionCoordinatorImpl, JtaTransactionCoordinatorImpl

public interface TransactionCoordinator

Models the coordination of all transaction related flows.

Author:

Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TransactionCoordinator.TransactionDriver Provides the means for "local transactions" (as transaction drivers) to control the underlying "physical transaction" currently associated with the TransactionCoordinator.

Method Summary

Modifier and Type	Method and Description
void	addObserver(TransactionObserver observer) Adds an observer to the coordinator.
IsolationDelegate	createIsolationDelegate() Retrieve an isolation delegate appropriate for this transaction strategy.
void	explicitJoin() Indicates an explicit request to join a transaction.
SynchronizationRegistry	getLocalSynchronizations() Get access to the local registry of Synchronization instances
int	getTimeOut()
TransactionCoordinatorBuilder	getTransactionCoordinatorBuilder()
TransactionCoordinator.TransactionDriver	getTransactionDriverControl() Get the delegate used by the local transaction driver to control the underlying transaction
boolean	isActive() Is this transaction still active? Answers on a best effort basis.
boolean	isJoined() Determine if there is an active transaction that this coordinator is already joined to.
void	pulse() Used by owner of the JdbcSession as a means to indicate that implicit joining should be done if needed.
void	removeObserver(TransactionObserver observer) Removed an observer from the coordinator.
void	setTimeOut(int seconds)

Method Detail

explicitJoin

void explicitJoin()

Indicates an explicit request to join a transaction. This is mainly intended to handle the JPA requirement around EntityManager.joinTransaction(), and generally speaking only has an impact in JTA environments

isJoined

boolean isJoined()

Determine if there is an active transaction that this coordinator is already joined to.

Returns:

true if there is an active transaction this coordinator is already joined to; false otherwise.

pulse

void pulse()

Used by owner of the JdbcSession as a means to indicate that implicit joining should be done if needed.

getTransactionDriverControl

TransactionCoordinator.TransactionDriver getTransactionDriverControl()

Get the delegate used by the local transaction driver to control the underlying transaction

Returns:

The control delegate.

getLocalSynchronizations

SynchronizationRegistry getLocalSynchronizations()

Get access to the local registry of Synchronization instances

Returns:

The local Synchronization registry

isActive

boolean isActive()

Is this transaction still active?

Answers on a best effort basis. For example, in the case of JDBC based transactions we cannot know that a transaction is active when it is initiated directly through the JDBC Connection, only when it is initiated from here.

Returns:

true if the transaction is still active; false otherwise.

Throws:

HibernateException - Indicates a problem checking the transaction status.

createIsolationDelegate

IsolationDelegate createIsolationDelegate()

Retrieve an isolation delegate appropriate for this transaction strategy.

Returns:

An isolation delegate.

addObserver

void addObserver(TransactionObserver observer)

Adds an observer to the coordinator.

observers are not to be cleared on transaction completion.

Parameters:

observer - The observer to add.

removeObserver

void removeObserver(TransactionObserver observer)

Removed an observer from the coordinator.

Parameters:

observer - The observer to remove.

getTransactionCoordinatorBuilder

TransactionCoordinatorBuilder getTransactionCoordinatorBuilder()

Returns:

setTimeOut

void setTimeOut(int seconds)

getTimeOut

int getTimeOut()