Class DataSourceTransactionManager
- All Implemented Interfaces:
Serializable,InitializingBean,ConfigurableTransactionManager,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
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
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 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
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 (for example, 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 (for example, 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)SavepointDataSourceUtils.getConnection(javax.sql.DataSource)DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)TransactionAwareDataSourceProxyLazyConnectionDataSourceProxyJdbcTemplateJdbcTransactionManager- Serialized Form
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
AbstractPlatformTransactionManager.SuspendedResourcesHolder -
Field Summary
Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION -
Constructor Summary
ConstructorsConstructorDescriptionCreate a newDataSourceTransactionManagerinstance.DataSourceTransactionManager(DataSource dataSource) Create a newDataSourceTransactionManagerinstance. -
Method Summary
Modifier 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 JDBCDataSourcethat this instance manages transactions for.Return the resource factory that this transaction manager operates on, for example, a JDBC DataSource or a JMS ConnectionFactory.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 theDataSourcefor actual use.protected voidprepareTransactionalConnection(Connection con, TransactionDefinition definition) Prepare the transactionalConnectionright after transaction begin.voidsetDataSource(DataSource dataSource) Set the JDBCDataSourcethat 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.AbstractPlatformTransactionManager
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionExecutionListeners, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, prepareForCommit, prepareSynchronization, registerAfterCompletionWithExistingTransaction, resume,