public class DataSourceTransactionManager extends AbstractPlatformTransactionManager implements ResourceTransactionManager, InitializingBean
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
Java 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
Java 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).
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 FormAbstractPlatformTransactionManager.SuspendedResourcesHolderlogger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION| Constructor and Description |
|---|
DataSourceTransactionManager()
Create a new DataSourceTransactionManager instance.
|
DataSourceTransactionManager(DataSource dataSource)
Create a new DataSourceTransactionManager instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
afterPropertiesSet()
Invoked by the containing
BeanFactory after it has set all bean properties
and satisfied BeanFactoryAware, ApplicationContextAware etc. |
protected void |
doBegin(Object transaction,
TransactionDefinition definition)
Begin a new transaction with semantics according to the given transaction
definition.
|
protected void |
doCleanupAfterCompletion(Object transaction)
Cleanup resources after transaction completion.
|
protected void |
doCommit(DefaultTransactionStatus status)
Perform an actual commit of the given transaction.
|
protected Object |
doGetTransaction()
Return a transaction object for the current transaction state.
|
protected void |
doResume(Object transaction,
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 Object |
doSuspend(Object transaction)
Suspend the resources of the current transaction.
|
DataSource |
getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
|
Object |
getResourceFactory()
Return the resource factory that this transaction manager operates on,
e.g.
|
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 transaction)
Check if the given transaction object indicates an existing transaction
(that is, a transaction which has already started).
|
protected DataSource |
obtainDataSource()
Obtain the DataSource for actual use.
|
protected void |
prepareTransactionalConnection(Connection con,
TransactionDefinition definition)
Prepare the transactional
Connection right after transaction begin. |
void |
setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for.
|
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. |
commit, 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, useSavepointForNestedTransactionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcommit, getTransaction, rollbackpublic DataSourceTransactionManager()
setDataSource(javax.sql.DataSource)public DataSourceTransactionManager(DataSource dataSource)
dataSource - the JDBC DataSource to manage transactions forpublic void setDataSource(@Nullable DataSource dataSource)
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.
@Nullable public DataSource getDataSource()
protected DataSource obtainDataSource()
null)IllegalStateException - in case of no DataSource setpublic void setEnforceReadOnly(boolean enforceReadOnly)
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(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.
public boolean isEnforceReadOnly()
setEnforceReadOnly(boolean)public void afterPropertiesSet()
InitializingBeanBeanFactory 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.
afterPropertiesSet in interface InitializingBeanpublic Object getResourceFactory()
ResourceTransactionManagerThis target resource factory is usually used as resource key for
TransactionSynchronizationManager's resource bindings per thread.
getResourceFactory in interface ResourceTransactionManagernull)TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object),
TransactionSynchronizationManager.getResource(java.lang.Object)protected Object doGetTransaction()
AbstractPlatformTransactionManagerThe 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.
doGetTransaction in class AbstractPlatformTransactionManagerAbstractPlatformTransactionManager.doBegin(java.lang.Object, org.springframework.transaction.TransactionDefinition),
AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus),
AbstractPlatformTransactionManager.doRollback(org.springframework.transaction.support.DefaultTransactionStatus),
DefaultTransactionStatus.getTransaction()protected boolean isExistingTransaction(Object transaction)
AbstractPlatformTransactionManagerThe 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.
isExistingTransaction in class AbstractPlatformTransactionManagertransaction - the transaction object returned by doGetTransactionAbstractPlatformTransactionManager.doGetTransaction()protected void doBegin(Object transaction, TransactionDefinition definition)
AbstractPlatformTransactionManagerThis 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.
doBegin in class AbstractPlatformTransactionManagertransaction - the transaction object returned by doGetTransactiondefinition - a TransactionDefinition instance, describing propagation
behavior, isolation level, read-only flag, timeout, and transaction nameprotected Object doSuspend(Object transaction)
AbstractPlatformTransactionManagerThe default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
doSuspend in class AbstractPlatformTransactionManagertransaction - the transaction object returned by doGetTransactionAbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)protected void doResume(@Nullable Object transaction, Object suspendedResources)
AbstractPlatformTransactionManagerThe default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
doResume in class AbstractPlatformTransactionManagertransaction - the transaction object returned by doGetTransactionsuspendedResources - the object that holds suspended resources,
as returned by doSuspendAbstractPlatformTransactionManager.doSuspend(java.lang.Object)protected void doCommit(DefaultTransactionStatus status)
AbstractPlatformTransactionManagerAn 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.
doCommit in class AbstractPlatformTransactionManagerstatus - the status representation of the transactionDefaultTransactionStatus.getTransaction()protected void doRollback(DefaultTransactionStatus status)
AbstractPlatformTransactionManagerAn 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.
doRollback in class AbstractPlatformTransactionManagerstatus - the status representation of the transactionDefaultTransactionStatus.getTransaction()protected void doSetRollbackOnly(DefaultTransactionStatus status)
AbstractPlatformTransactionManagerThe default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.
doSetRollbackOnly in class AbstractPlatformTransactionManagerstatus - the status representation of the transactionprotected void doCleanupAfterCompletion(Object transaction)
AbstractPlatformTransactionManagerCalled after doCommit and doRollback execution,
on any outcome. The default implementation does nothing.
Should not throw any exceptions but just issue warnings on errors.
doCleanupAfterCompletion in class AbstractPlatformTransactionManagertransaction - the transaction object returned by doGetTransactionprotected void prepareTransactionalConnection(Connection con, TransactionDefinition definition) throws SQLException
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.
con - the transactional JDBC Connectiondefinition - the current transaction definitionSQLException - if thrown by JDBC APIsetEnforceReadOnly(boolean)