Top Description Inners Methods
org.hibernate.resource.transaction.spi

public Interface TransactionCoordinator

Known Direct Implementers
org.hibernate.resource.transaction.backend.jdbc.internal.JdbcResourceLocalTransactionCoordinatorImpl, org.hibernate.resource.transaction.backend.jta.internal.JtaTransactionCoordinatorImpl
Imports
org.hibernate.engine.transaction.spi.IsolationDelegate, .TransactionObserver, org.hibernate.jpa.spi.JpaCompliance
Models the coordination of all transaction related flows.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public 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 TypeMethod and Description
public void
addObserver(TransactionObserver
The observer to add.
observer)

Adds an observer to the coordinator.

public IsolationDelegate

Returns:

An isolation delegate.
createIsolationDelegate()

Retrieve an isolation delegate appropriate for this transaction strategy.

public void
explicitJoin()

Indicates an explicit request to join a transaction.

public JpaCompliance
getJpaCompliance()

public SynchronizationRegistry

Returns:

The local Synchronization registry
getLocalSynchronizations()

Get access to the local registry of Synchronization instances

public int
getTimeOut()

public TransactionCoordinatorBuilder
getTransactionCoordinatorBuilder()

Access to the builder that generated this coordinator

public TransactionCoordinator.TransactionDriver

Returns:

The control delegate.
getTransactionDriverControl()

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

public default void
invalidate()

public boolean

Returns:

true if the transaction is still active; false otherwise.
isActive()

Is this transaction still active?

public boolean

Returns:

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

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

public default boolean
isTransactionActive()

public default boolean
isTransactionActive(boolean isMarkedRollbackConsideredActive)

public void
pulse()

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

public void
removeObserver(TransactionObserver
The observer to remove.
observer)

Removed an observer from the coordinator.

public void
setTimeOut(int seconds)

Method Detail

addObserverback to summary
public void addObserver(TransactionObserver observer)

Adds an observer to the coordinator.

observers are not to be cleared on transaction completion.

Parameters
observer:TransactionObserver

The observer to add.

createIsolationDelegateback to summary
public IsolationDelegate createIsolationDelegate()

Retrieve an isolation delegate appropriate for this transaction strategy.

Returns:IsolationDelegate

An isolation delegate.

explicitJoinback to summary
public void explicitJoin()

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

getJpaComplianceback to summary
public JpaCompliance getJpaCompliance()
getLocalSynchronizationsback to summary
public SynchronizationRegistry getLocalSynchronizations()

Get access to the local registry of Synchronization instances

Returns:SynchronizationRegistry

The local Synchronization registry

getTimeOutback to summary
public int getTimeOut()
getTransactionCoordinatorBuilderback to summary
public TransactionCoordinatorBuilder getTransactionCoordinatorBuilder()

Access to the builder that generated this coordinator

getTransactionDriverControlback to summary
public TransactionCoordinator.TransactionDriver getTransactionDriverControl()

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

Returns:TransactionCoordinator.TransactionDriver

The control delegate.

invalidateback to summary
public default void invalidate()
isActiveback to summary
public 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 java.sql.Connection, only when it is initiated from here.

Returns:boolean

true if the transaction is still active; false otherwise.

Exceptions
HibernateException:
Indicates a problem checking the transaction status.
isJoinedback to summary
public boolean isJoined()

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

Returns:boolean

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

isTransactionActiveback to summary
public default boolean isTransactionActive()
isTransactionActiveback to summary
public default boolean isTransactionActive(boolean isMarkedRollbackConsideredActive)
pulseback to summary
public void pulse()

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

removeObserverback to summary
public void removeObserver(TransactionObserver observer)

Removed an observer from the coordinator.

Parameters
observer:TransactionObserver

The observer to remove.

setTimeOutback to summary
public void setTimeOut(int seconds)
org.hibernate.resource.transaction.spi back to summary

public Interface TransactionCoordinator.TransactionDriver

Known Direct Implementers
org.hibernate.resource.transaction.backend.jdbc.internal.JdbcResourceLocalTransactionCoordinatorImpl.TransactionDriverControlImpl, org.hibernate.resource.transaction.backend.jta.internal.JtaTransactionCoordinatorImpl.TransactionDriverControlImpl
Provides the means for "local transactions" (as transaction drivers) to control the underlying "physical transaction" currently associated with the TransactionCoordinator.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public void
begin()

Begin the physical transaction

public void
commit()

Commit the physical transaction

public TransactionStatus
getStatus()

public default boolean
isActive(boolean isMarkedRollbackConsideredActive)

public void
markRollbackOnly()

public void
rollback()

Rollback the physical transaction

Method Detail

beginback to summary
public void begin()

Begin the physical transaction

commitback to summary
public void commit()

Commit the physical transaction

getStatusback to summary
public TransactionStatus getStatus()
isActiveback to summary
public default boolean isActive(boolean isMarkedRollbackConsideredActive)
markRollbackOnlyback to summary
public void markRollbackOnly()
rollbackback to summary
public void rollback()

Rollback the physical transaction