public class DataSourceTransactionManager
extends org.springframework.transaction.support.AbstractPlatformTransactionManager
implements org.springframework.transaction.support.ResourceTransactionManager, org.springframework.beans.factory.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
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. 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
.
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 FormConstructor and Description |
---|
DataSourceTransactionManager()
Create a new DataSourceTransactionManager instance.
|
DataSourceTransactionManager(DataSource dataSource)
Create a new DataSourceTransactionManager instance.
|
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet() |
protected void |
doBegin(Object transaction,
org.springframework.transaction.TransactionDefinition definition) |
protected void |
doCleanupAfterCompletion(Object transaction) |
protected void |
doCommit(org.springframework.transaction.support.DefaultTransactionStatus status) |
protected Object |
doGetTransaction() |
protected void |
doResume(Object transaction,
Object suspendedResources) |
protected void |
doRollback(org.springframework.transaction.support.DefaultTransactionStatus status) |
protected void |
doSetRollbackOnly(org.springframework.transaction.support.DefaultTransactionStatus status) |
protected Object |
doSuspend(Object transaction) |
DataSource |
getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
|
Object |
getResourceFactory() |
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) |
protected DataSource |
obtainDataSource()
Obtain the DataSource for actual use.
|
protected void |
prepareTransactionalConnection(Connection con,
org.springframework.transaction.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. |
protected RuntimeException |
translateException(String task,
SQLException ex)
Translate the given JDBC commit/rollback exception to a common Spring
exception to propagate from the
AbstractPlatformTransactionManager.commit(org.springframework.transaction.TransactionStatus) /AbstractPlatformTransactionManager.rollback(org.springframework.transaction.TransactionStatus) call. |
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, useSavepointForNestedTransaction
public 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.
TransactionAwareDataSourceProxy
,
org.springframework.transaction.jta.JtaTransactionManager
@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()
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
public Object getResourceFactory()
getResourceFactory
in interface org.springframework.transaction.support.ResourceTransactionManager
protected Object doGetTransaction()
doGetTransaction
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected boolean isExistingTransaction(Object transaction)
isExistingTransaction
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doBegin(Object transaction, org.springframework.transaction.TransactionDefinition definition)
doBegin
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected Object doSuspend(Object transaction)
doSuspend
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doResume(@Nullable Object transaction, Object suspendedResources)
doResume
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doCommit(org.springframework.transaction.support.DefaultTransactionStatus status)
doCommit
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doRollback(org.springframework.transaction.support.DefaultTransactionStatus status)
doRollback
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doSetRollbackOnly(org.springframework.transaction.support.DefaultTransactionStatus status)
doSetRollbackOnly
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doCleanupAfterCompletion(Object transaction)
doCleanupAfterCompletion
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void prepareTransactionalConnection(Connection con, org.springframework.transaction.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)
protected RuntimeException translateException(String task, SQLException ex)
AbstractPlatformTransactionManager.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.
task
- the task description (commit or rollback)ex
- the SQLException thrown from commit/rollbackDataAccessException
or a
TransactionException