org.springframework.transaction.PlatformTransactionManager implementation for a single JDBC javax.sql.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 typically come from a connection pool but the DataSource must not return specifically scoped or constrained Connections. This transaction manager will associate Connections with thread-bound transactions, 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 EE-style DataSource#getConnection() call. Spring classes such as org.springframework.jdbc.core.JdbcTemplate use this strategy implicitly. 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 EE-style lookup pattern DataSource#getConnection(), for example for legacy code that is not aware of Spring at all. In that case, define a TransactionAwareDataSourceProxy for your target DataSource, and pass that proxy DataSource to your DAOs which will automatically participate in Spring-managed transactions when accessing it.

Supports custom isolation levels, and timeouts which get applied as appropriate JDBC statement timeouts. To support the latter, application code must either use org.springframework.jdbc.core.JdbcTemplate, call DataSourceUtils#applyTransactionTimeout for each created JDBC Statement, or go through a TransactionAwareDataSourceProxy which will create timeout-aware JDBC Connections and Statements automatically.

Consider defining a LazyConnectionDataSourceProxy for your target DataSource, pointing both this transaction manager and your DAOs to it. This will lead to optimized handling of "empty" transactions, i.e. of transactions without any JDBC statements executed. A LazyConnectionDataSourceProxy will not fetch an actual JDBC Connection from the target DataSource until a Statement gets executed, lazily applying the specified transaction settings to the target Connection.

This transaction manager supports nested transactions via the JDBC java.sql.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).

This transaction manager can be used as a replacement for the org.springframework.transaction.jta.JtaTransactionManager in the single resource case, as it does not require a container that supports JTA, typically in combination with a locally defined JDBC DataSource (e.g. a Hikari connection pool). Switching between this local strategy and a JTA environment is just a matter of configuration!

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).

NOTE: As of 5.3, org.springframework.jdbc.support.JdbcTransactionManager is available as an extended subclass which includes commit/rollback exception translation, aligned with org.springframework.jdbc.core.JdbcTemplate.

Author: Juergen Hoeller
Since: 02.05.2003
See Also: setNestedTransactionAllowed, java.sql.Savepoint, DataSourceUtils#getConnection(javax.sql.DataSource), DataSourceUtils#applyTransactionTimeout, DataSourceUtils#releaseConnection, TransactionAwareDataSourceProxy, LazyConnectionDataSourceProxy, org.springframework.jdbc.core.JdbcTemplate, org.springframework.jdbc.support.JdbcTransactionManager

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DataSourceTransactionManager.DataSourceTransactionObject DataSource transaction object, representing a ConnectionHolder.

Field Summary

Modifier and Type	Field and Description
private DataSource	dataSource
private boolean	enforceReadOnly

Inherited from org.springframework.transaction.support.AbstractPlatformTransactionManager:: logger SYNCHRONIZATION_ALWAYS SYNCHRONIZATION_NEVER SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

Access	Constructor and Description
public	DataSourceTransactionManager() Create a new `DataSourceTransactionManager` instance.
public	DataSourceTransactionManager(DataSource the JDBC DataSource to manage transactions for dataSource) Create a new `DataSourceTransactionManager` instance.

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected void	doBegin(Object the transaction object returned by `doGetTransaction` transaction, TransactionDefinition a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name definition) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin. Begin a new transaction with semantics according to the given transaction definition.
protected void	doCleanupAfterCompletion(Object the transaction object returned by `doGetTransaction` transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion. Cleanup resources after transaction completion.
protected void	doCommit(DefaultTransactionStatus the status representation of the transaction status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit. Perform an actual commit of the given transaction.
protected Object	doGetTransaction() Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction. Return a transaction object for the current transaction state.
protected void	doResume(Object the transaction object returned by `doGetTransaction` transaction, Object the object that holds suspended resources, as returned by doSuspend suspendedResources) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume. Resume the resources of the current transaction.
protected void	doRollback(DefaultTransactionStatus the status representation of the transaction status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback. Perform an actual rollback of the given transaction.
protected void	doSetRollbackOnly(DefaultTransactionStatus the status representation of the transaction status) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly. Set the given transaction rollback-only.
protected Object	doSuspend(Object the transaction object returned by `doGetTransaction` transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend. Suspend the resources of the current transaction.
public DataSource	getDataSource() Return the JDBC `DataSource` that this instance manages transactions for.
public Object	getResourceFactory() Implements org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory. Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.
public boolean	isEnforceReadOnly() Return whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.
protected boolean	isExistingTransaction(Object the transaction object returned by doGetTransaction transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction. Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
protected DataSource	Returns: the DataSource (never `null`) obtainDataSource() Obtain the `DataSource` for actual use.
protected void	prepareTransactionalConnection(Connection the transactional JDBC Connection con, TransactionDefinition the current transaction definition definition) Prepare the transactional `Connection` right after transaction begin.
public void	setDataSource(DataSource dataSource) Set the JDBC `DataSource` that this instance should manage transactions for.
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.
protected RuntimeException	Returns: the translated exception to throw, either a `org.springframework.dao.DataAccessException` or a `org.springframework.transaction.TransactionException` translateException(String the task description (commit or rollback) task, SQLException the SQLException thrown from commit/rollback ex) Translate the given JDBC commit/rollback exception to a common Spring exception to propagate from the `commit`/`rollback` call.

Inherited from org.springframework.transaction.support.AbstractPlatformTransactionManager:: commit determineTimeout getDefaultTimeout getTransaction getTransactionExecutionListeners getTransactionSynchronization invokeAfterCompletion isFailEarlyOnGlobalRollbackOnly isGlobalRollbackOnParticipationFailure isNestedTransactionAllowed isRollbackOnCommitFailure isValidateExistingTransaction prepareForCommit prepareSynchronization registerAfterCompletionWithExistingTransaction resume rollback setDefaultTimeout setFailEarlyOnGlobalRollbackOnly setGlobalRollbackOnParticipationFailure setNestedTransactionAllowed setRollbackOnCommitFailure setTransactionExecutionListeners setTransactionSynchronization setTransactionSynchronizationName setValidateExistingTransaction shouldCommitOnGlobalRollbackOnly suspend triggerBeforeCommit triggerBeforeCompletion useSavepointForNestedTransaction

Field Detail

dataSource	back to summary
private DataSource dataSource Annotations @Nullable

enforceReadOnly	back to summary
private boolean enforceReadOnly

Constructor Detail

DataSourceTransactionManager back to summary

DataSourceTransactionManager	back to summary
public DataSourceTransactionManager() Create a new `DataSourceTransactionManager` instance. A `DataSource` has to be set to be able to use it. See Also `setDataSource`

public DataSourceTransactionManager()

Create a new DataSourceTransactionManager instance. A DataSource has to be set to be able to use it.

See Also: setDataSource

DataSourceTransactionManager back to summary

DataSourceTransactionManager	back to summary
public DataSourceTransactionManager(DataSource dataSource) Create a new `DataSourceTransactionManager` instance. Parameters dataSource:DataSource the JDBC DataSource to manage transactions for

public DataSourceTransactionManager(DataSource dataSource)

Create a new DataSourceTransactionManager instance.

Parameters

dataSource:DataSource: the JDBC DataSource to manage transactions for

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

doBegin back to summary

doBegin	back to summary
protected void doBegin(Object transaction, TransactionDefinition definition) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin. Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager. This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended. A special scenario is a nested transaction without savepoint: If `useSavepointForNestedTransaction()` returns "false", this method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction. Parameters transaction:Object the transaction object returned by `doGetTransaction` definition:TransactionDefinition a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name Annotations @Override

protected void doBegin(Object transaction, TransactionDefinition definition)

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin.

Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.

This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended.

A special scenario is a nested transaction without savepoint: If useSavepointForNestedTransaction() returns "false", this method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction.

Parameters

transaction:Object: the transaction object returned by doGetTransaction
definition:TransactionDefinition: a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name

Annotations

@Override

doCleanupAfterCompletion back to summary

doCleanupAfterCompletion	back to summary
protected void doCleanupAfterCompletion(Object transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion. 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. Parameters transaction:Object the transaction object returned by `doGetTransaction` Annotations @Override

protected void doCleanupAfterCompletion(Object transaction)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion.

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.

Parameters

transaction:Object: the transaction object returned by doGetTransaction

Annotations

@Override

doCommit	back to summary
protected void doCommit(DefaultTransactionStatus status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit. 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. Parameters status:DefaultTransactionStatus the status representation of the transaction Annotations @Override

doCommit

back to summary

protected void doCommit(DefaultTransactionStatus status)

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit.

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.

Parameters

status:DefaultTransactionStatus: the status representation of the transaction

Annotations

@Override

doGetTransaction back to summary

doGetTransaction	back to summary
protected Object doGetTransaction() Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction. 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. Returns:Object the current transaction object Annotations @Override

protected Object doGetTransaction()

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction.

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.

Returns:Object

the current transaction object

Annotations

@Override

doResume back to summary

doResume	back to summary
protected void doResume(Object transaction, Object suspendedResources) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume. 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. Parameters transaction:Object the transaction object returned by `doGetTransaction` suspendedResources:Object the object that holds suspended resources, as returned by doSuspend Annotations @Override

protected void doResume(Object transaction, Object suspendedResources)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume.

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.

Parameters

transaction:Object: the transaction object returned by doGetTransaction
suspendedResources:Object: the object that holds suspended resources, as returned by doSuspend

Annotations

@Override

doRollback	back to summary
protected void doRollback(DefaultTransactionStatus status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback. 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. Parameters status:DefaultTransactionStatus the status representation of the transaction Annotations @Override

doRollback

back to summary

protected void doRollback(DefaultTransactionStatus status)

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback.

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.

Parameters

status:DefaultTransactionStatus: the status representation of the transaction

Annotations

@Override

doSetRollbackOnly	back to summary
protected void doSetRollbackOnly(DefaultTransactionStatus status) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly. 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. Parameters status:DefaultTransactionStatus the status representation of the transaction Annotations @Override

doSetRollbackOnly

back to summary

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly.

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.

Parameters

status:DefaultTransactionStatus: the status representation of the transaction

Annotations

@Override

doSuspend back to summary

doSuspend	back to summary
protected Object doSuspend(Object transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend. 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. Parameters transaction:Object the transaction object returned by `doGetTransaction` Returns:Object an object that holds suspended resources (will be kept unexamined for passing it into doResume) Annotations @Override

protected Object doSuspend(Object transaction)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend.

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.

Parameters

transaction:Object: the transaction object returned by doGetTransaction

Returns:Object

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

Annotations

@Override

getDataSource back to summary

getDataSource	back to summary
public DataSource getDataSource() Return the JDBC `DataSource` that this instance manages transactions for. Annotations @Nullable

public DataSource getDataSource()

Return the JDBC DataSource that this instance manages transactions for.

Annotations

@Nullable

getResourceFactory back to summary

getResourceFactory	back to summary
public Object getResourceFactory() Implements org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory. Doc from org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory. 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. Returns:Object the target resource factory (never `null`) Annotations @Override

public Object getResourceFactory()

Implements org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory.

Doc from org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory.

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.

Returns:Object

the target resource factory (never null)

Annotations

@Override

isEnforceReadOnly back to summary

isEnforceReadOnly	back to summary
public boolean isEnforceReadOnly() 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`

public boolean isEnforceReadOnly()

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

isExistingTransaction back to summary

isExistingTransaction	back to summary
protected boolean isExistingTransaction(Object transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction. 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. Parameters transaction:Object the transaction object returned by doGetTransaction Returns:boolean if there is an existing transaction Annotations @Override

protected boolean isExistingTransaction(Object transaction)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction.

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.

Parameters

transaction:Object: the transaction object returned by doGetTransaction

Returns:boolean

if there is an existing transaction

Annotations

@Override

obtainDataSource back to summary

obtainDataSource	back to summary
protected DataSource obtainDataSource() Obtain the `DataSource` for actual use. Returns:DataSource the DataSource (never `null`) Exceptions IllegalStateException: in case of no DataSource set Since 5.0

protected DataSource obtainDataSource()

Obtain the DataSource for actual use.

Returns:DataSource

the DataSource (never null)

Exceptions

IllegalStateException:: in case of no DataSource set

Since

5.0

prepareTransactionalConnection back to summary

prepareTransactionalConnection	back to summary
protected void prepareTransactionalConnection(Connection con, TransactionDefinition definition) throws 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:Connection the transactional JDBC Connection definition:TransactionDefinition the current transaction definition Exceptions SQLException: if thrown by JDBC API Since 4.3.7 See Also `setEnforceReadOnly`

protected void prepareTransactionalConnection(Connection con, TransactionDefinition definition) throws 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:Connection: the transactional JDBC Connection
definition:TransactionDefinition: the current transaction definition

Exceptions

SQLException:: if thrown by JDBC API

Since

4.3.7

See Also

setEnforceReadOnly

setDataSource back to summary

setDataSource	back to summary
public void setDataSource(DataSource dataSource) Set the JDBC `DataSource` that this instance should manage transactions for. This will typically be a locally defined `DataSource`, for example a Hikari connection pool. Alternatively, you can also manage transactions for a non-XA `DataSource` fetched from JNDI. For an XA `DataSource`, use `org.springframework.transaction.jta.JtaTransactionManager` instead. The `DataSource` specified here should be the target `DataSource` to manage transactions for, not a `TransactionAwareDataSourceProxy`. Only data access code may work with `TransactionAwareDataSourceProxy` while the transaction manager needs to work on the underlying target `DataSource`. If there is nevertheless a `TransactionAwareDataSourceProxy` passed in, it will be unwrapped to extract its target `DataSource`. The `DataSource` passed in here needs to return independent `Connection`s. The `Connection`s typically come from a connection pool but the `DataSource` must not return specifically scoped or constrained `Connection`s, just possibly lazily fetched. See Also `LazyConnectionDataSourceProxy`

public void setDataSource(DataSource dataSource)

Set the JDBC DataSource that this instance should manage transactions for.

This will typically be a locally defined DataSource, for example a Hikari connection pool. Alternatively, you can also manage transactions for a non-XA DataSource fetched from JNDI. For an XA DataSource, use org.springframework.transaction.jta.JtaTransactionManager instead.

The DataSource specified here should be the target DataSource to manage transactions for, not a TransactionAwareDataSourceProxy. Only data access code may work with TransactionAwareDataSourceProxy while the transaction manager needs to work on the underlying target DataSource. If there is nevertheless a TransactionAwareDataSourceProxy passed in, it will be unwrapped to extract its target DataSource.

The DataSource passed in here needs to return independent Connections. The Connections typically come from a connection pool but the DataSource must not return specifically scoped or constrained Connections, just possibly lazily fetched.

See Also: LazyConnectionDataSourceProxy

setEnforceReadOnly back to summary

setEnforceReadOnly	back to summary
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 `prepareTransactionalConnection`. This mode of read-only handling goes beyond the `Connection#setReadOnly` 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. Since 4.3.7 See Also `prepareTransactionalConnection`

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 prepareTransactionalConnection.

This mode of read-only handling goes beyond the Connection#setReadOnly 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.

Since: 4.3.7
See Also: prepareTransactionalConnection

translateException back to summary

translateException	back to summary
protected RuntimeException translateException(String task, SQLException ex) Translate the given JDBC commit/rollback exception to a common Spring exception to propagate from the `commit`/`rollback` call. The default implementation throws a `TransactionSystemException`. Subclasses may specifically identify concurrency failures etc. Parameters task:String the task description (commit or rollback) ex:SQLException the SQLException thrown from commit/rollback Returns:RuntimeException the translated exception to throw, either a `org.springframework.dao.DataAccessException` or a `org.springframework.transaction.TransactionException` Since 5.3

protected RuntimeException translateException(String task, SQLException ex)

Translate the given JDBC commit/rollback exception to a common Spring exception to propagate from the commit/rollback call.

The default implementation throws a TransactionSystemException. Subclasses may specifically identify concurrency failures etc.

Parameters

task:String: the task description (commit or rollback)
ex:SQLException: the SQLException thrown from commit/rollback

Returns:RuntimeException

the translated exception to throw, either a org.springframework.dao.DataAccessException or a org.springframework.transaction.TransactionException

Since

5.3

org.springframework.jdbc.datasource back to summary

private Class DataSourceTransactionManager.DataSourceTransactionObject

Class Inheritance

extends JdbcTransactionObjectSupport

java.lang.Object
org.springframework.jdbc.datasource.JdbcTransactionObjectSupport
org.springframework.jdbc.datasource.DataSourceTransactionManager.DataSourceTransactionObject

DataSource transaction object, representing a ConnectionHolder. Used as transaction object by DataSourceTransactionManager.

Field Summary

Modifier and Type	Field and Description
private boolean	mustRestoreAutoCommit
private boolean	newConnectionHolder

Constructor Summary

Access	Constructor and Description
private	DataSourceTransactionObject()

Method Summary

Modifier and Type	Method and Description
public void	flush() Overrides default org.springframework.transaction.support.SmartTransactionObject.flush. Flush the underlying sessions to the datastore, if applicable: for example, all affected Hibernate/JPA sessions.
public boolean	isMustRestoreAutoCommit()
public boolean	isNewConnectionHolder()
public boolean	isRollbackOnly() Overrides default org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly. Return whether the transaction is internally marked as rollback-only.
public void	setConnectionHolder(ConnectionHolder connectionHolder, boolean newConnectionHolder)
public void	setMustRestoreAutoCommit(boolean mustRestoreAutoCommit)
public void	setRollbackOnly()

Inherited from org.springframework.jdbc.datasource.JdbcTransactionObjectSupport:: createSavepoint getConnectionHolder getConnectionHolderForSavepoint getPreviousIsolationLevel hasConnectionHolder isReadOnly isSavepointAllowed releaseSavepoint rollbackToSavepoint setConnectionHolder setPreviousIsolationLevel setReadOnly setSavepointAllowed

Field Detail

mustRestoreAutoCommit	back to summary
private boolean mustRestoreAutoCommit

newConnectionHolder	back to summary
private boolean newConnectionHolder

Constructor Detail

DataSourceTransactionObject	back to summary
private DataSourceTransactionObject()

Method Detail

flush	back to summary
public void flush() Overrides default org.springframework.transaction.support.SmartTransactionObject.flush. Doc from org.springframework.transaction.support.SmartTransactionObject.flush. Flush the underlying sessions to the datastore, if applicable: for example, all affected Hibernate/JPA sessions. The default implementation is empty, considering flush as a no-op. Annotations @Override

flush

back to summary

public void flush()

Overrides default org.springframework.transaction.support.SmartTransactionObject.flush.

Doc from org.springframework.transaction.support.SmartTransactionObject.flush.

Flush the underlying sessions to the datastore, if applicable: for example, all affected Hibernate/JPA sessions.

The default implementation is empty, considering flush as a no-op.

Annotations

@Override

isMustRestoreAutoCommit	back to summary
public boolean isMustRestoreAutoCommit()

isNewConnectionHolder	back to summary
public boolean isNewConnectionHolder()

isRollbackOnly back to summary

isRollbackOnly	back to summary
public boolean isRollbackOnly() Overrides default org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly. Doc from org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly. Return whether the transaction is internally marked as rollback-only. Can, for example, check the JTA UserTransaction. The default implementation returns `false`. Annotations @Override

public boolean isRollbackOnly()

Overrides default org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly.

Doc from org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly.

Return whether the transaction is internally marked as rollback-only. Can, for example, check the JTA UserTransaction.

The default implementation returns false.

Annotations

@Override

setConnectionHolder	back to summary
public void setConnectionHolder(ConnectionHolder connectionHolder, boolean newConnectionHolder)

setMustRestoreAutoCommit	back to summary
public void setMustRestoreAutoCommit(boolean mustRestoreAutoCommit)

setRollbackOnly	back to summary
public void setRollbackOnly()

public Class DataSourceTransactionManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DataSourceTransactionManager.DataSourceTransactionObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail