io.micronaut.transaction.jdbc

Class DataSourceTransactionManager

java.lang.Object

io.micronaut.transaction.support.AbstractSynchronousTransactionManager<java.sql.Connection>

io.micronaut.transaction.jdbc.DataSourceTransactionManager

All Implemented Interfaces:

ResourceTransactionManager<javax.sql.DataSource,java.sql.Connection>, SynchronousTransactionManager<java.sql.Connection>, TransactionManager, TransactionOperations<java.sql.Connection>, java.io.Serializable

@EachBean(value=javax.sql.DataSource.class)
public class DataSourceTransactionManager
extends AbstractSynchronousTransactionManager<java.sql.Connection>
implements ResourceTransactionManager<javax.sql.DataSource,java.sql.Connection>

NOTICE: This is a fork of Spring's PlatformTransactionManager modernizing it to use enums, Slf4j and decoupling from Spring. SynchronousTransactionManager implementation for a single JDBC DataSource. This class is capable of working in any environment with any JDBC driver, as long as the setup uses a javax.sql.DataSource as its Connection factory mechanism. Binds a JDBC Connection from the specified DataSource to the current thread, potentially allowing for one thread-bound Connection per DataSource.

Note: The DataSource that this transaction manager operates on needs to return independent Connections. The Connections may come from a pool (the typical case), but the DataSource must not return thread-scoped / request-scoped Connections or the like. This transaction manager will associate Connections with thread-bound transactions itself, according to the specified propagation behavior. It assumes that a separate, independent Connection can be obtained even during an ongoing transaction.

Application code is required to retrieve the JDBC Connection via DataSourceUtils.getConnection(DataSource) instead of a standard Java EE-style DataSource.getConnection() call. If not used in combination with this transaction manager, the DataSourceUtils lookup strategy behaves exactly like the native DataSource lookup; it can thus be used in a portable fashion.

Alternatively, you can allow application code to work with the standard Java EE-style lookup pattern DataSource.getConnection().

This transaction manager supports nested transactions via the JDBC 3.0 Savepoint mechanism. The "nestedTransactionAllowed" flag defaults to "true", since nested transactions will work without restrictions on JDBC drivers that support savepoints (such as the Oracle JDBC driver).

As of 4.3.4, this transaction manager triggers flush callbacks on registered transaction synchronizations (if synchronization is generally active), assuming resources operating on the underlying JDBC Connection. This allows for setup analogous to JtaTransactionManager, in particular with respect to lazily registered ORM resources (e.g. a Hibernate Session).

Since:

02.05.2003

Author:

Juergen Hoeller, graemerocher

See Also:

AbstractSynchronousTransactionManager.setNestedTransactionAllowed(boolean), Savepoint, DataSourceUtils.getConnection(javax.sql.DataSource), DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource), DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

AbstractSynchronousTransactionManager.SuspendedResourcesHolder

Field Summary

Fields inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

logger

Constructor Summary

Constructors

Constructor and Description
DataSourceTransactionManager(javax.sql.DataSource dataSource) Create a new DataSourceTransactionManager instance.

Method Summary

Modifier and Type	Method and Description
protected void	doBegin(java.lang.Object transaction, TransactionDefinition definition) This implementation sets the isolation level but ignores the timeout.
protected void	doCleanupAfterCompletion(java.lang.Object transaction) Cleanup resources after transaction completion.
protected void	doCommit(DefaultTransactionStatus status) Perform an actual commit of the given transaction.
protected java.lang.Object	doGetTransaction() Return a transaction object for the current transaction state.
protected void	doResume(java.lang.Object transaction, java.lang.Object suspendedResources) Resume the resources of the current transaction.
protected void	doRollback(DefaultTransactionStatus status) Perform an actual rollback of the given transaction.
protected void	doSetRollbackOnly(DefaultTransactionStatus status) Set the given transaction rollback-only.
protected java.lang.Object	doSuspend(java.lang.Object transaction) Suspend the resources of the current transaction.
java.sql.Connection	getConnection() Obtains the connection for the current transaction.
protected java.sql.Connection	getConnection(java.lang.Object transaction) The connection for the given transaction object.
javax.sql.DataSource	getDataSource()
javax.sql.DataSource	getResourceFactory() Return the resource factory that this transaction manager operates on, e.g.
boolean	isEnforceReadOnly()
protected boolean	isExistingTransaction(java.lang.Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
protected void	prepareTransactionalConnection(java.sql.Connection con, TransactionDefinition definition) Prepare the transactional Connection right after transaction begin.
void	setEnforceReadOnly(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated by TransactionDefinition.isReadOnly() through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.

Methods inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

commit, determineTimeout, execute, executeRead, executeWrite, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.transaction.SynchronousTransactionManager

commit, getTransaction, rollback

Methods inherited from interface io.micronaut.transaction.TransactionOperations

execute, executeRead, executeWrite

Constructor Detail

DataSourceTransactionManager

public DataSourceTransactionManager(@NonNull
                                    javax.sql.DataSource dataSource)

Create a new DataSourceTransactionManager instance.

Parameters:

dataSource - the JDBC DataSource to manage transactions for

Method Detail

getDataSource

@NonNull
public javax.sql.DataSource getDataSource()

Returns:

Return the JDBC DataSource that this instance manages transactions for.

setEnforceReadOnly

public void setEnforceReadOnly(boolean enforceReadOnly)

Specify whether to enforce the read-only nature of a transaction (as indicated by TransactionDefinition.isReadOnly() through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.

The exact treatment, including any SQL statement executed on the connection, can be customized through through prepareTransactionalConnection(java.sql.Connection, io.micronaut.transaction.TransactionDefinition).

This mode of read-only handling goes beyond the Connection.setReadOnly(boolean) hint that Spring applies by default. In contrast to that standard JDBC hint, "SET TRANSACTION READ ONLY" enforces an isolation-level-like connection mode where data manipulation statements are strictly disallowed. Also, on Oracle, this read-only mode provides read consistency for the entire transaction.

Note that older Oracle JDBC drivers (9i, 10g) used to enforce this read-only mode even for Connection.setReadOnly(true. However, with recent drivers, this strong enforcement needs to be applied explicitly, e.g. through this flag.

Parameters:

enforceReadOnly - True if read-only should be enforced

Since:

4.3.7

See Also:

prepareTransactionalConnection(java.sql.Connection, io.micronaut.transaction.TransactionDefinition)

isEnforceReadOnly

public boolean isEnforceReadOnly()

Returns:

Return whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.

Since:

4.3.7

See Also:

setEnforceReadOnly(boolean)

getResourceFactory

public javax.sql.DataSource getResourceFactory()

Description copied from interface: ResourceTransactionManager

Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.

This target resource factory is usually used as resource key for TransactionSynchronizationManager's resource bindings per thread.

Specified by:

getResourceFactory in interface ResourceTransactionManager<javax.sql.DataSource,java.sql.Connection>

Returns:

the target resource factory (never null)

See Also:

TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object), TransactionSynchronizationManager.getResource(java.lang.Object)

getConnection

protected java.sql.Connection getConnection(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

The connection for the given transaction object.

Specified by:

getConnection in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - The transaction

Returns:

The connection.

doGetTransaction

protected java.lang.Object doGetTransaction()

Description copied from class: AbstractSynchronousTransactionManager

Return a transaction object for the current transaction state.

The returned object will usually be specific to the concrete transaction manager implementation, carrying corresponding transaction state in a modifiable fashion. This object will be passed into the other template methods (e.g. doBegin and doCommit), either directly or as part of a DefaultTransactionStatus instance.

The returned object should contain information about any existing transaction, that is, a transaction that has already started before the current getTransaction call on the transaction manager. Consequently, a doGetTransaction implementation will usually look for an existing transaction and store corresponding state in the returned transaction object.

Specified by:

doGetTransaction in class AbstractSynchronousTransactionManager<java.sql.Connection>

Returns:

the current transaction object

See Also:

AbstractSynchronousTransactionManager.doBegin(java.lang.Object, io.micronaut.transaction.TransactionDefinition), AbstractSynchronousTransactionManager.doCommit(io.micronaut.transaction.support.DefaultTransactionStatus), AbstractSynchronousTransactionManager.doRollback(io.micronaut.transaction.support.DefaultTransactionStatus), DefaultTransactionStatus.getTransaction()

isExistingTransaction

protected boolean isExistingTransaction(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).

The result will be evaluated according to the specified propagation behavior for the new transaction. An existing transaction might get suspended (in case of PROPAGATION_REQUIRES_NEW), or the new transaction might participate in the existing one (in case of PROPAGATION_REQUIRED).

The default implementation returns false, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

Overrides:

isExistingTransaction in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

if there is an existing transaction

See Also:

AbstractSynchronousTransactionManager.doGetTransaction()

doBegin

protected void doBegin(java.lang.Object transaction,
                       TransactionDefinition definition)

This implementation sets the isolation level but ignores the timeout.

Specified by:

doBegin in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

definition - a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name

doSuspend

protected java.lang.Object doSuspend(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

Suspend the resources of the current transaction. Transaction synchronization will already have been suspended.

The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

Overrides:

doSuspend in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

an object that holds suspended resources (will be kept unexamined for passing it into doResume)

See Also:

AbstractSynchronousTransactionManager.doResume(java.lang.Object, java.lang.Object)

doResume

protected void doResume(@Nullable
                        java.lang.Object transaction,
                        java.lang.Object suspendedResources)

Description copied from class: AbstractSynchronousTransactionManager

Resume the resources of the current transaction. Transaction synchronization will be resumed afterwards.

The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

Overrides:

doResume in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

suspendedResources - the object that holds suspended resources, as returned by doSuspend

See Also:

AbstractSynchronousTransactionManager.doSuspend(java.lang.Object)

doCommit

protected void doCommit(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

Perform an actual commit of the given transaction.

An implementation does not need to check the "new transaction" flag or the rollback-only flag; this will already have been handled before. Usually, a straight commit will be performed on the transaction object contained in the passed-in status.

Specified by:

doCommit in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

status - the status representation of the transaction

See Also:

DefaultTransactionStatus.getTransaction()

doRollback

protected void doRollback(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

Perform an actual rollback of the given transaction.

An implementation does not need to check the "new transaction" flag; this will already have been handled before. Usually, a straight rollback will be performed on the transaction object contained in the passed-in status.

Specified by:

doRollback in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

status - the status representation of the transaction

See Also:

DefaultTransactionStatus.getTransaction()

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

Set the given transaction rollback-only. Only called on rollback if the current transaction participates in an existing one.

The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

Overrides:

doSetRollbackOnly in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

status - the status representation of the transaction

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

Cleanup resources after transaction completion.

Called after doCommit and doRollback execution, on any outcome. The default implementation does nothing.

Should not throw any exceptions but just issue warnings on errors.

Overrides:

doCleanupAfterCompletion in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

prepareTransactionalConnection

protected void prepareTransactionalConnection(java.sql.Connection con,
                                              TransactionDefinition definition)
                                       throws java.sql.SQLException

Prepare the transactional Connection right after transaction begin.

The default implementation executes a "SET TRANSACTION READ ONLY" statement if the "enforceReadOnly" flag is set to true and the transaction definition indicates a read-only transaction.

The "SET TRANSACTION READ ONLY" is understood by Oracle, MySQL and Postgres and may work with other databases as well. If you'd like to adapt this treatment, override this method accordingly.

Parameters:

con - the transactional JDBC Connection

definition - the current transaction definition

Throws:

java.sql.SQLException - if thrown by JDBC API

Since:

4.3.7

See Also:

setEnforceReadOnly(boolean)

getConnection

@NonNull
public java.sql.Connection getConnection()

Description copied from interface: TransactionOperations

Obtains the connection for the current transaction.

Specified by:

getConnection in interface TransactionOperations<java.sql.Connection>

Returns:

The connection