org.springframework.jdbc.datasource
Class DataSourceTransactionManager

java.lang.Object
  org.springframework.transaction.support.AbstractPlatformTransactionManager
      org.springframework.jdbc.datasource.DataSourceTransactionManager

All Implemented Interfaces:

InitializingBean, PlatformTransactionManager, java.io.Serializable

public class DataSourceTransactionManager

extends AbstractPlatformTransactionManager

implements InitializingBean

PlatformTransactionManager implementation for a single JDBC DataSource. Binds a JDBC connection from the specified DataSource to the thread, potentially allowing for one thread connection per data source.

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. All framework classes like JdbcTemplate use this strategy implicitly. If not used with this transaction manager, the 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 through 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 query timeouts. To support the latter, application code must either use JdbcTemplate or call DataSourceUtils.applyTransactionTimeout for each created statement.

On JDBC 3.0, this transaction manager supports nested transactions via JDBC 3.0 Savepoints. The "nestedTransactionAllowed" flag defaults to true, as nested transactions work without restrictions on JDBC drivers that support Savepoints (like Oracle).

This implementation can be used instead of JtaTransactionManager in the single resource case, as it does not require the container to support JTA: typically, in combination with a locally defined JDBC DataSource like a Jakarta Commons DBCP connection pool. Switching between this local strategy and a JTA environment is just a matter of configuration, if you stick to the required connection lookup pattern. Note that JTA does not support custom isolation levels!

Since:

02.05.2003

Author:

Juergen Hoeller

See Also:

AbstractPlatformTransactionManager.setNestedTransactionAllowed(boolean), Savepoint, DataSourceUtils.getConnection(javax.sql.DataSource), DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource), DataSourceUtils.closeConnectionIfNecessary(java.sql.Connection, javax.sql.DataSource), TransactionAwareDataSourceProxy, JdbcTemplate, 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(javax.sql.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(java.lang.Object transaction, TransactionDefinition definition) This implementation sets the isolation level but ignores the timeout.
protected void	doCleanupAfterCompletion(java.lang.Object transaction) Cleanup resources after transaction completion.
protected void	doCommit(DefaultTransactionStatus status) Perform an actual commit on the given transaction.
protected java.lang.Object	doGetTransaction() Return a current transaction object, i.e. a JTA UserTransaction.
protected void	doResume(java.lang.Object transaction, java.lang.Object suspendedResources) Resume the resources of the current transaction.
protected void	doRollback(DefaultTransactionStatus status) Perform an actual rollback on the given transaction.
protected void	doSetRollbackOnly(DefaultTransactionStatus status) Set the given transaction rollback-only.
protected java.lang.Object	doSuspend(java.lang.Object transaction) Suspend the resources of the current transaction.
javax.sql.DataSource	getDataSource() Return the JDBC DataSource that this instance manages transactions for.
protected boolean	isExistingTransaction(java.lang.Object transaction) Check if the given transaction object indicates an existing, i.e. already begun, transaction.
void	setDataSource(javax.sql.DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.

Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

commit, getTransaction, getTransactionSynchronization, isNestedTransactionAllowed, isRollbackOnCommitFailure, rollback, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSourceTransactionManager

public DataSourceTransactionManager()

Create a new DataSourceTransactionManager instance. A DataSource has to be set to be able to use it.

See Also:

setDataSource(javax.sql.DataSource)

DataSourceTransactionManager

public DataSourceTransactionManager(javax.sql.DataSource dataSource)

Create a new DataSourceTransactionManager instance.

Parameters:

dataSource - JDBC DataSource to manage transactions for

Method Detail

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

Set the JDBC DataSource that this instance should manage transactions for.

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.

See Also:

JtaTransactionManager

getDataSource

public javax.sql.DataSource getDataSource()

Return the JDBC DataSource that this instance manages transactions for.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This 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.

Specified by:

afterPropertiesSet in interface InitializingBean

doGetTransaction

protected java.lang.Object doGetTransaction()

Description copied from class: AbstractPlatformTransactionManager

Return a current transaction object, i.e. a JTA UserTransaction.

Specified by:

doGetTransaction in class AbstractPlatformTransactionManager

Returns:

the current transaction object

isExistingTransaction

protected boolean isExistingTransaction(java.lang.Object transaction)

Description copied from class: AbstractPlatformTransactionManager

Check if the given transaction object indicates an existing, i.e. already begun, transaction.

Specified by:

isExistingTransaction in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

if there is an existing transaction

doBegin

protected void doBegin(java.lang.Object transaction,
                       TransactionDefinition definition)

This implementation sets the isolation level but ignores the timeout.

Specified by:

doBegin in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

definition - TransactionDefinition instance, describing propagation behavior, isolation level, timeout etc.

doSuspend

protected java.lang.Object doSuspend(java.lang.Object transaction)

Description copied from class: AbstractPlatformTransactionManager

Suspend the resources of the current transaction. Transaction synchronization will already have been suspended.

Specified by:

doSuspend in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

an object that holds suspended resources (will be kept unexamined for passing it into doResume)

See Also:

AbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)

doResume

protected void doResume(java.lang.Object transaction,
                        java.lang.Object suspendedResources)

Description copied from class: AbstractPlatformTransactionManager

Resume the resources of the current transaction. Transaction synchronization will be resumed afterwards.

Specified by:

doResume in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

suspendedResources - the object that holds suspended resources, as returned by doSuspend

See Also:

AbstractPlatformTransactionManager.doSuspend(java.lang.Object)

doCommit

protected void doCommit(DefaultTransactionStatus status)

Description copied from class: AbstractPlatformTransactionManager

Perform an actual commit on the given transaction. An implementation does not need to check the rollback-only flag.

Specified by:

doCommit in class AbstractPlatformTransactionManager

Parameters:

status - status representation of the transaction

doRollback

protected void doRollback(DefaultTransactionStatus status)

Description copied from class: AbstractPlatformTransactionManager

Perform an actual rollback on the given transaction. An implementation does not need to check the new transaction flag.

Specified by:

doRollback in class AbstractPlatformTransactionManager

Parameters:

status - status representation of the transaction

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Description copied from class: AbstractPlatformTransactionManager

Set the given transaction rollback-only. Only called on rollback if the current transaction takes part in an existing one.

Specified by:

doSetRollbackOnly in class AbstractPlatformTransactionManager

Parameters:

status - status representation of the transaction

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(java.lang.Object transaction)

Description copied from class: AbstractPlatformTransactionManager

Cleanup resources after transaction completion. Called after doCommit and doRollback execution on any outcome. Should not throw any exceptions but just issue warnings on errors.

Default implementation does nothing.

Overrides:

doCleanupAfterCompletion in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction