org.hibernate.resource.transaction.package-info Maven / Gradle / Ivy

Go to download
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */

/**
 * Defines the resource-level transaction capabilities of Hibernate, which revolves around the
 * {@link org.hibernate.resource.transaction.spi.TransactionCoordinator} contract.
 * 
 * TransactionCoordinator instances can be obtained from
 * {@link org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder}, which is a Service
 * and available from the StandardServiceRegistry
 * 

 * A few terms/concepts to keep in mind here...
 *
 * 
Local transaction
 *
 * The local transaction is the idea of transactionality exposed to the application (as
 * {@link org.hibernate.Transaction}) as a means to control the underlying transaction.  That
 * control flows from the {@link org.hibernate.Transaction} into the TransactionCoordinator
 * through the {@link org.hibernate.resource.transaction.spi.TransactionCoordinator.TransactionDriver} it exposes.
 *
 * Physical transaction
 *
 * This is the physical underlying transaction that ultimately controls the database transaction.  This
 * can be:
 *     
 *       a JTA transaction, as expressed by {@link jakarta.transaction.UserTransaction} or
 *       {@link jakarta.transaction.Transaction})
 *     
 *     
 *         a "JDBC transaction", as expressed through the JDBC {@link java.sql.Connection} object
 *     
 * 
 *
 * The corresponding concrete TransactionCoordinator implementations manage that bridging internally.
 *
 * Local Synchronization
 *
 * The Hibernate transaction api allows the application itself to register JTA Synchronization
 * objects with the TransactionCoordinator.  These local Synchronizations work in all transaction
 * environments.  See {@link org.hibernate.Transaction#registerSynchronization} and
 * {@link org.hibernate.resource.transaction.spi.SynchronizationRegistry} for additional details.
 *
 */
package org.hibernate.resource.transaction;