org.springframework.orm.ojb
Class PersistenceBrokerTransactionManager

java.lang.Object
  org.springframework.transaction.support.AbstractPlatformTransactionManager
      org.springframework.orm.ojb.PersistenceBrokerTransactionManager

All Implemented Interfaces:

Serializable, PlatformTransactionManager

public class PersistenceBrokerTransactionManager
extends AbstractPlatformTransactionManager

PlatformTransactionManager implementation for a single OJB persistence broker key. Binds an OJB PersistenceBroker from the specified key to the thread, potentially allowing for one thread PersistenceBroker per key. OjbFactoryUtils and PersistenceBrokerTemplate are aware of thread-bound persistence brokers and participate in such transactions automatically. Using either is required for OJB access code supporting this transaction management mechanism.

This implementation is appropriate for applications that solely use OJB for transactional data access. JTA (usually through JtaTransactionManager) is necessary for accessing multiple transactional resources, in combination with transactional DataSources as connection pools (to be specified in OJB's configuration).

Since:

1.1

Author:

Juergen Hoeller

See Also:

setJcdAlias(java.lang.String), setPbKey(org.apache.ojb.broker.PBKey), OjbFactoryUtils.getPersistenceBroker(org.apache.ojb.broker.PBKey, boolean), OjbFactoryUtils.releasePersistenceBroker(org.apache.ojb.broker.PersistenceBroker, org.apache.ojb.broker.PBKey), PersistenceBrokerTemplate, JtaTransactionManager, Serialized Form

Field Summary

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

logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

PersistenceBrokerTransactionManager()
Create a new PersistenceBrokerTransactionManager, sing the default connection configured for OJB.

PersistenceBrokerTransactionManager(org.apache.ojb.broker.PBKey pbKey)
Create a new PersistenceBrokerTransactionManager.

PersistenceBrokerTransactionManager(String jcdAlias)
Create a new PersistenceBrokerTransactionManager.

Method Summary

protected void	doBegin(Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition.
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.
org.apache.ojb.broker.PBKey	getPbKey() Return the PBKey of the PersistenceBroker configuration used.
protected org.apache.ojb.broker.PersistenceBroker	getPersistenceBroker() Get an OJB PersistenceBroker for the PBKey of this transaction manager.
protected boolean	isExistingTransaction(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
protected void	releasePersistenceBroker(org.apache.ojb.broker.PersistenceBroker pb) Close the given PersistenceBroker, created for the PBKey of this transaction manager, if it isn't bound to the thread.
void	setDataSource(DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.
void	setJcdAlias(String jcdAlias) Set the JDBC Connection Descriptor alias of the PersistenceBroker configuration to use.
void	setPbKey(org.apache.ojb.broker.PBKey pbKey) Set the PBKey of the PersistenceBroker configuration to use.

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

commit, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, registerAfterCompletionWithExistingTransaction, rollback, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, shouldCommitOnGlobalRollbackOnly, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistenceBrokerTransactionManager

public PersistenceBrokerTransactionManager()

Create a new PersistenceBrokerTransactionManager, sing the default connection configured for OJB.

PersistenceBrokerTransactionManager

public PersistenceBrokerTransactionManager(String jcdAlias)

Create a new PersistenceBrokerTransactionManager.

Parameters:

jcdAlias - the JDBC Connection Descriptor alias of the PersistenceBroker configuration to use

PersistenceBrokerTransactionManager

public PersistenceBrokerTransactionManager(org.apache.ojb.broker.PBKey pbKey)

Create a new PersistenceBrokerTransactionManager.

Parameters:

pbKey - the PBKey of the PersistenceBroker configuration to use

Method Detail

setJcdAlias

public void setJcdAlias(String jcdAlias)

Set the JDBC Connection Descriptor alias of the PersistenceBroker configuration to use. Default is the default connection configured for OJB.

setPbKey

public void setPbKey(org.apache.ojb.broker.PBKey pbKey)

Set the PBKey of the PersistenceBroker configuration to use. Default is the default connection configured for OJB.

getPbKey

public org.apache.ojb.broker.PBKey getPbKey()

Return the PBKey of the PersistenceBroker configuration used.

setDataSource

public void setDataSource(DataSource dataSource)

Set the JDBC DataSource that this instance should manage transactions for. The DataSource should match the one configured for the OJB JCD alias: for example, you could specify the same JNDI DataSource for both.

A transactional JDBC Connection for this DataSource will be provided to application code accessing this DataSource directly via DataSourceUtils or JdbcTemplate. The Connection will be taken from the Hibernate Session.

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.

See Also:

LocalDataSourceConnectionProvider, LocalSessionFactoryBean.setDataSource(javax.sql.DataSource), DataSourceUtils.getConnection(javax.sql.DataSource), JdbcTemplate, TransactionAwareDataSourceProxy

getDataSource

public DataSource getDataSource()

Return the JDBC DataSource that this instance manages transactions for.

doGetTransaction

protected Object doGetTransaction()

Description copied from class: AbstractPlatformTransactionManager

Return a transaction object for the current transaction state.

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

Specified by:

doGetTransaction in class AbstractPlatformTransactionManager

Returns:

the current transaction object

See Also:

AbstractPlatformTransactionManager.doBegin(java.lang.Object, org.springframework.transaction.TransactionDefinition), AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus), AbstractPlatformTransactionManager.doRollback(org.springframework.transaction.support.DefaultTransactionStatus), DefaultTransactionStatus.getTransaction()

isExistingTransaction

protected boolean isExistingTransaction(Object transaction)

Description copied from class: AbstractPlatformTransactionManager

Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).

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

Overrides:

isExistingTransaction in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

if there is an existing transaction

See Also:

AbstractPlatformTransactionManager.doGetTransaction()

doBegin

protected void doBegin(Object transaction,
                       TransactionDefinition definition)

Description copied from class: AbstractPlatformTransactionManager

Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.

This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended.

A special scenario is a nested transaction without savepoint: If useSavepointForNestedTransaction() returns "false", this method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction.

Specified by:

doBegin in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

definition - TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name

doSuspend

protected Object doSuspend(Object transaction)

Description copied from class: AbstractPlatformTransactionManager

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

The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

Overrides:

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(Object transaction,
                        Object suspendedResources)

Description copied from class: AbstractPlatformTransactionManager

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

The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

Overrides:

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 of the given transaction.

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

Specified by:

doCommit in class AbstractPlatformTransactionManager

Parameters:

status - the status representation of the transaction

See Also:

DefaultTransactionStatus.getTransaction()

doRollback

protected void doRollback(DefaultTransactionStatus status)

Description copied from class: AbstractPlatformTransactionManager

Perform an actual rollback of the given transaction.

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

Specified by:

doRollback in class AbstractPlatformTransactionManager

Parameters:

status - the status representation of the transaction

See Also:

DefaultTransactionStatus.getTransaction()

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 participates in an existing one.

The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

Overrides:

doSetRollbackOnly in class AbstractPlatformTransactionManager

Parameters:

status - the status representation of the transaction

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(Object transaction)

Description copied from class: AbstractPlatformTransactionManager

Cleanup resources after transaction completion.

Called after doCommit and doRollback execution, on any outcome. The default implementation does nothing.

Should not throw any exceptions but just issue warnings on errors.

Overrides:

doCleanupAfterCompletion in class AbstractPlatformTransactionManager

Parameters:

transaction - transaction object returned by doGetTransaction

getPersistenceBroker

protected org.apache.ojb.broker.PersistenceBroker getPersistenceBroker()
                                                                throws org.apache.ojb.broker.OJBRuntimeException

Get an OJB PersistenceBroker for the PBKey of this transaction manager.

Default implementation simply creates a new PersistenceBroker. Can be overridden in subclasses, e.g. for testing purposes.

Returns:

the PersistenceBroker

Throws:

org.apache.ojb.broker.OJBRuntimeException - if PersistenceBroker cretion failed

See Also:

setJcdAlias(java.lang.String), setPbKey(org.apache.ojb.broker.PBKey), PersistenceBrokerFactory.createPersistenceBroker(org.apache.ojb.broker.PBKey)

releasePersistenceBroker

protected void releasePersistenceBroker(org.apache.ojb.broker.PersistenceBroker pb)

Close the given PersistenceBroker, created for the PBKey of this transaction manager, if it isn't bound to the thread.

Default implementation delegates to OjbFactoryUtils. Can be overridden in subclasses, e.g. for testing purposes.

Parameters:

pb - PersistenceBroker to close

See Also:

setJcdAlias(java.lang.String), setPbKey(org.apache.ojb.broker.PBKey), OjbFactoryUtils.releasePersistenceBroker(org.apache.ojb.broker.PersistenceBroker, org.apache.ojb.broker.PBKey)