Class DataSourceTransactionManager
- All Implemented Interfaces:
- Serializable,- InitializingBean,- PlatformTransactionManager,- ResourceTransactionManager,- TransactionManager
- Direct Known Subclasses:
- JdbcTransactionManager
PlatformTransactionManager
 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
 Jakarta EE-style DataSource.getConnection() call. Spring classes such as
 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
 Jakarta 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 JdbcTemplate, call
 DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource) 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 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).
 
This transaction manager can be used as a replacement for the
 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. an Apache Commons
 DBCP 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, JdbcTransactionManager
 is available as an extended subclass which includes commit/rollback exception
 translation, aligned with JdbcTemplate.
- Since:
- 02.05.2003
- Author:
- Juergen Hoeller
- See Also:
- 
- AbstractPlatformTransactionManager.setNestedTransactionAllowed(boolean)
- Savepoint
- DataSourceUtils.getConnection(javax.sql.DataSource)
- DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
- DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
- TransactionAwareDataSourceProxy
- LazyConnectionDataSourceProxy
- JdbcTemplate
- Serialized Form
 
- 
Nested Class SummaryNested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManagerAbstractPlatformTransactionManager.SuspendedResourcesHolder
- 
Field SummaryFields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManagerlogger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a new DataSourceTransactionManager instance.DataSourceTransactionManager(DataSource dataSource) Create a new DataSourceTransactionManager instance.
- 
Method SummaryModifier and TypeMethodDescriptionvoidInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.protected voiddoBegin(Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition.protected voiddoCleanupAfterCompletion(Object transaction) Cleanup resources after transaction completion.protected voiddoCommit(DefaultTransactionStatus status) Perform an actual commit of the given transaction.protected ObjectReturn a transaction object for the current transaction state.protected voidResume the resources of the current transaction.protected voiddoRollback(DefaultTransactionStatus status) Perform an actual rollback of the given transaction.protected voidSet the given transaction rollback-only.protected ObjectSuspend the resources of the current transaction.Return the JDBC DataSource that this instance manages transactions for.Return the resource factory that this transaction manager operates on, e.g.booleanReturn whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.protected booleanisExistingTransaction(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).protected DataSourceObtain the DataSource for actual use.protected voidprepareTransactionalConnection(Connection con, TransactionDefinition definition) Prepare the transactionalConnectionright after transaction begin.voidsetDataSource(DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.voidsetEnforceReadOnly(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated byTransactionDefinition.isReadOnly()) through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.protected RuntimeExceptiontranslateException(String task, SQLException ex) Translate the given JDBC commit/rollback exception to a common Spring exception to propagate from theAbstractPlatformTransactionManager.commit(org.springframework.transaction.TransactionStatus)/AbstractPlatformTransactionManager.rollback(org.springframework.transaction.TransactionStatus)call.Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManagercommit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransactionMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.transaction.PlatformTransactionManagercommit, getTransaction, rollback
- 
Constructor Details- 
DataSourceTransactionManagerpublic DataSourceTransactionManager()Create a new DataSourceTransactionManager instance. A DataSource has to be set to be able to use it.- See Also:
 
- 
DataSourceTransactionManagerCreate a new DataSourceTransactionManager instance.- Parameters:
- dataSource- the JDBC DataSource to manage transactions for
 
 
- 
- 
Method Details- 
setDataSourceSet the JDBC DataSource that this instance should manage transactions for.This will typically be a locally defined DataSource, for example an Apache Commons DBCP connection pool. Alternatively, you can also drive transactions for a non-XA J2EE DataSource fetched from JNDI. For an XA DataSource, use JtaTransactionManager. 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's 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 may come from a pool (the typical case), but the DataSource must not return thread-scoped / request-scoped Connections or the like. 
- 
getDataSourceReturn the JDBC DataSource that this instance manages transactions for.
- 
obtainDataSourceObtain the DataSource for actual use.- Returns:
- the DataSource (never null)
- Throws:
- IllegalStateException- in case of no DataSource set
- Since:
- 5.0
 
- 
setEnforceReadOnlypublic void setEnforceReadOnly(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated byTransactionDefinition.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(java.sql.Connection, org.springframework.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.
- 
isEnforceReadOnlypublic 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:
 
- 
afterPropertiesSetpublic void afterPropertiesSet()Description copied from interface:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. - Specified by:
- afterPropertiesSetin interface- InitializingBean
 
- 
getResourceFactoryDescription copied from interface:ResourceTransactionManagerReturn 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:
- getResourceFactoryin interface- ResourceTransactionManager
- Returns:
- the target resource factory (never null)
- See Also:
 
- 
doGetTransactionDescription copied from class:AbstractPlatformTransactionManagerReturn 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 getTransactioncall on the transaction manager. Consequently, adoGetTransactionimplementation will usually look for an existing transaction and store corresponding state in the returned transaction object.- Specified by:
- doGetTransactionin class- AbstractPlatformTransactionManager
- Returns:
- the current transaction object
- See Also:
- 
- AbstractPlatformTransactionManager.doBegin(java.lang.Object, org.springframework.transaction.TransactionDefinition)
- AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus)
- AbstractPlatformTransactionManager.doRollback(org.springframework.transaction.support.DefaultTransactionStatus)
- DefaultTransactionStatus.getTransaction()
 
 
- 
isExistingTransactionDescription copied from class:AbstractPlatformTransactionManagerCheck 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:
- isExistingTransactionin class- AbstractPlatformTransactionManager
- Parameters:
- transaction- the transaction object returned by doGetTransaction
- Returns:
- if there is an existing transaction
- See Also:
 
- 
doBeginDescription copied from class:AbstractPlatformTransactionManagerBegin 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.- Specified by:
- doBeginin class- AbstractPlatformTransactionManager
- Parameters:
- transaction- the transaction object returned by- doGetTransaction
- definition- a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name
 
- 
doSuspendDescription copied from class:AbstractPlatformTransactionManagerSuspend 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:
- doSuspendin class- AbstractPlatformTransactionManager
- Parameters:
- transaction- the transaction object returned by- doGetTransaction
- Returns:
- an object that holds suspended resources (will be kept unexamined for passing it into doResume)
- See Also:
 
- 
doResumeDescription copied from class:AbstractPlatformTransactionManagerResume 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:
- doResumein class- AbstractPlatformTransactionManager
- Parameters:
- transaction- the transaction object returned by- doGetTransaction
- suspendedResources- the object that holds suspended resources, as returned by doSuspend
- See Also:
 
- 
doCommitDescription copied from class:AbstractPlatformTransactionManagerPerform 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:
- doCommitin class- AbstractPlatformTransactionManager
- Parameters:
- status- the status representation of the transaction
- See Also:
 
- 
doRollbackDescription copied from class:AbstractPlatformTransactionManagerPerform 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:
- doRollbackin class- AbstractPlatformTransactionManager
- Parameters:
- status- the status representation of the transaction
- See Also:
 
- 
doSetRollbackOnlyDescription copied from class:AbstractPlatformTransactionManagerSet 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:
- doSetRollbackOnlyin class- AbstractPlatformTransactionManager
- Parameters:
- status- the status representation of the transaction
 
- 
doCleanupAfterCompletionDescription copied from class:AbstractPlatformTransactionManagerCleanup resources after transaction completion.Called after doCommitanddoRollbackexecution, on any outcome. The default implementation does nothing.Should not throw any exceptions but just issue warnings on errors. - Overrides:
- doCleanupAfterCompletionin class- AbstractPlatformTransactionManager
- Parameters:
- transaction- the transaction object returned by- doGetTransaction
 
- 
prepareTransactionalConnectionprotected void prepareTransactionalConnection(Connection con, TransactionDefinition definition) throws SQLException Prepare the transactionalConnectionright after transaction begin.The default implementation executes a "SET TRANSACTION READ ONLY" statement if the "enforceReadOnly"flag is set totrueand 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:
- SQLException- if thrown by JDBC API
- Since:
- 4.3.7
- See Also:
 
- 
translateExceptionTranslate the given JDBC commit/rollback exception to a common Spring exception to propagate from theAbstractPlatformTransactionManager.commit(org.springframework.transaction.TransactionStatus)/AbstractPlatformTransactionManager.rollback(org.springframework.transaction.TransactionStatus)call.The default implementation throws a TransactionSystemException. Subclasses may specifically identify concurrency failures etc.- Parameters:
- task- the task description (commit or rollback)
- ex- the SQLException thrown from commit/rollback
- Returns:
- the translated exception to throw, either a
 DataAccessExceptionor aTransactionException
- Since:
- 5.3
 
 
-