org.springframework.transaction.support.AbstractPlatformTransactionManager
org.springframework.jdbc.datasource.DataSourceTransactionManager
|
The Spring Framework | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class DataSourceTransactionManager
PlatformTransactionManager implementation for a single JDBC DataSource.
capable of working in any environment with any JDBC driver, as long as the setup
uses a JDBC 2.0 Standard Extensions / JDBC 3.0 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.
Application code is required to retrieve the JDBC Connection via
DataSourceUtils.getConnection(DataSource) instead of J2EE's standard
DataSource.getConnection(). This is recommended anyway, as it throws
unchecked org.springframework.dao exceptions instead of checked
SQLException. Spring classes such as JdbcTemplate use this strategy implicitly.
If not used with this transaction manager, the DataSourceUtils lookup strategy
behaves exactly like the common one; it can thus be used in any case.
Alternatively, you can also allow application code to work with the standard
J2EE 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. Note that DataSourceTransactionManager still needs
to be wired with the target DataSource, driving transactions for it.
Supports custom isolation levels, and timeouts that 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 Statement, or go through a TransactionAwareDataSourceProxy
which will create timeout-aware Connections and Statements.
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. transactions
without any JDBC statements executed. LazyConnectionDataSourceProxy will not fetch
a JDBC Connection from the target DataSource until the first Statement execution,
lazily applying the specified transaction settings to the target Conection.
On JDBC 3.0, this transaction manager supports nested transactions via the
JDBC 3.0 Savepoint mechanism. The "nestedTransactionAllowed" flag
defaults to "true", since nested transactions work without restrictions on JDBC
drivers that support savepoints (such as the Oracle JDBC driver).
This implementation 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. a Jakarta Commons DBCP
connection pool). Switching between this local strategy and a JTA environment is
just a matter of configuration!
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,
org.springframework.jdbc.object,
Serialized Form| Field Summary |
|---|
| Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager |
|---|
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION |
| Constructor Summary | |
|---|---|
DataSourceTransactionManager()
Create a new DataSourceTransactionManager instance. |
|
DataSourceTransactionManager(DataSource dataSource)
Create a new DataSourceTransactionManager instance. |
|
| Method Summary | |
|---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). |
protected void |
doBegin(Object transaction,
TransactionDefinition definition)
This implementation sets the isolation level but ignores the timeout. |
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. |
protected boolean |
isExistingTransaction(Object transaction)
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started). |
void |
setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DataSourceTransactionManager()
setDataSource(javax.sql.DataSource)public DataSourceTransactionManager(DataSource dataSource)
dataSource - JDBC DataSource to manage transactions for| Method Detail |
|---|
public void setDataSource(DataSource dataSource)
This will typically be a locally defined DataSource, for example a Jakarta 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.
TransactionAwareDataSourceProxy,
JtaTransactionManagerpublic DataSource getDataSource()
public void afterPropertiesSet()
InitializingBeanThis method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet in interface InitializingBeanprotected 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 - transaction object returned by doGetTransaction
AbstractPlatformTransactionManager.doGetTransaction()
protected void doBegin(Object transaction,
TransactionDefinition definition)
doBegin in class AbstractPlatformTransactionManagertransaction - transaction object returned by doGetTransactiondefinition - 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 - transaction object returned by doGetTransaction
AbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)
protected void doResume(Object transaction,
Object suspendedResources)
AbstractPlatformTransactionManagerThe default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
doResume in class AbstractPlatformTransactionManagertransaction - 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 - transaction object returned by doGetTransaction
|
The Spring Framework | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||