Class TransactionAwareDataSourceProxy
- All Implemented Interfaces:
Wrapper
,CommonDataSource
,DataSource
,InitializingBean
DataSource
, adding awareness of
Spring-managed transactions. Similar to a transactional JNDI DataSource
as provided by a Jakarta EE server.
Data access code that should remain unaware of Spring's data access support
can work with this proxy to seamlessly participate in Spring-managed transactions.
Note that the transaction manager, for example DataSourceTransactionManager
,
still needs to work with the underlying DataSource, not with this proxy.
Make sure that TransactionAwareDataSourceProxy is the outermost DataSource
of a chain of DataSource proxies/adapters. TransactionAwareDataSourceProxy
can delegate either directly to the target connection pool or to some
intermediary proxy/adapter like LazyConnectionDataSourceProxy
or
UserCredentialsDataSourceAdapter
.
Delegates to DataSourceUtils
for automatically participating in
thread-bound transactions, for example managed by DataSourceTransactionManager
.
getConnection
calls and close
calls on returned Connections
will behave properly within a transaction, i.e. always operate on the transactional
Connection. If not within a transaction, normal DataSource behavior applies.
This proxy allows data access code to work with the plain JDBC API and still participate in Spring-managed transactions, similar to JDBC code in a Jakarta EE/JTA environment. However, if possible, use Spring's DataSourceUtils, JdbcTemplate or JDBC operation objects to get transaction participation even without a proxy for the target DataSource, avoiding the need to define such a proxy in the first place.
As a further effect, using a transaction-aware DataSource will apply remaining transaction timeouts to all created JDBC (Prepared/Callable)Statement. This means that all operations performed through standard JDBC will automatically participate in Spring-managed transaction timeouts.
NOTE: This DataSource proxy needs to return wrapped Connections (which
implement the ConnectionProxy
interface) in order to handle close calls
properly. Use Wrapper.unwrap(java.lang.Class<T>)
to retrieve the native JDBC Connection.
- Since:
- 1.1
- Author:
- Juergen Hoeller
- See Also:
-
Constructor Summary
ConstructorDescriptionCreate a new TransactionAwareDataSourceProxy.TransactionAwareDataSourceProxy
(DataSource targetDataSource) Create a new TransactionAwareDataSourceProxy. -
Method Summary
Modifier and TypeMethodDescriptionDelegates to DataSourceUtils for automatically participating in Spring-managed transactions.protected Connection
getTransactionAwareConnectionProxy
(DataSource targetDataSource) Wraps the given Connection with a proxy that delegates every method call to it but delegatesclose()
calls to DataSourceUtils.void
setLazyTransactionalConnections
(boolean lazyTransactionalConnections) Specify whether to obtain the transactional target Connection lazily on actual data access.void
setReobtainTransactionalConnections
(boolean reobtainTransactionalConnections) Specify whether to reobtain the target Connection for each operation performed within a transaction.protected boolean
shouldObtainFixedConnection
(DataSource targetDataSource) Determine whether to obtain a fixed target Connection for the proxy or to reobtain the target Connection for each operation.Methods inherited from class org.springframework.jdbc.datasource.DelegatingDataSource
afterPropertiesSet, createConnectionBuilder, createShardingKeyBuilder, getConnection, getLoginTimeout, getLogWriter, getParentLogger, getTargetDataSource, isWrapperFor, obtainTargetDataSource, setLoginTimeout, setLogWriter, setTargetDataSource, unwrap
-
Constructor Details
-
TransactionAwareDataSourceProxy
public TransactionAwareDataSourceProxy()Create a new TransactionAwareDataSourceProxy. -
TransactionAwareDataSourceProxy
Create a new TransactionAwareDataSourceProxy.- Parameters:
targetDataSource
- the target DataSource
-
-
Method Details
-
setLazyTransactionalConnections
public void setLazyTransactionalConnections(boolean lazyTransactionalConnections) Specify whether to obtain the transactional target Connection lazily on actual data access.The default is "true". Specify "false" to immediately obtain a target Connection when a transaction-aware Connection handle is retrieved.
- Since:
- 6.1.2
-
setReobtainTransactionalConnections
public void setReobtainTransactionalConnections(boolean reobtainTransactionalConnections) Specify whether to reobtain the target Connection for each operation performed within a transaction.The default is "false". Specify "true" to reobtain transactional Connections for every call on the Connection proxy; this is advisable on JBoss if you hold on to a Connection handle across transaction boundaries.
The effect of this setting is similar to the "hibernate.connection.release_mode" value "after_statement".
-
getConnection
Delegates to DataSourceUtils for automatically participating in Spring-managed transactions. Throws the original SQLException, if any.The returned Connection handle implements the ConnectionProxy interface, allowing to retrieve the underlying target Connection.
- Specified by:
getConnection
in interfaceDataSource
- Overrides:
getConnection
in classDelegatingDataSource
- Returns:
- a transactional Connection if any, a new one else
- Throws:
SQLException
- See Also:
-
getTransactionAwareConnectionProxy
Wraps the given Connection with a proxy that delegates every method call to it but delegatesclose()
calls to DataSourceUtils.- Parameters:
targetDataSource
- the DataSource that the Connection came from- Returns:
- the wrapped Connection
- See Also:
-
shouldObtainFixedConnection
Determine whether to obtain a fixed target Connection for the proxy or to reobtain the target Connection for each operation.The default implementation returns
true
for all standard cases. This can be overridden through the"reobtainTransactionalConnections"
flag, which enforces a non-fixed target Connection within an active transaction. Note that non-transactional access will always use a fixed Connection.- Parameters:
targetDataSource
- the target DataSource
-