PersistenceBrokerTransactionManager (Spring Framework)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.orm.ojb
Class PersistenceBrokerTransactionManager

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

All Implemented Interfaces:: PlatformTransactionManager, Serializable

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 respectively 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.closePersistenceBrokerIfNecessary(org.apache.ojb.broker.PersistenceBroker, org.apache.ojb.broker.PBKey), PersistenceBrokerTemplate.execute(org.springframework.orm.ojb.PersistenceBrokerCallback), 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`	`closePersistenceBrokerIfNecessary(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.
`protected void`	`doBegin(Object transaction, TransactionDefinition definition)` Begin a new transaction with the given transaction definition.
`protected void`	`doCleanupAfterCompletion(Object transaction)` Cleanup resources after transaction completion.
`protected void`	`doCommit(DefaultTransactionStatus status)` Perform an actual commit on the given transaction.
`protected Object`	`doGetTransaction()` Return a current transaction object, i.e. a JTA UserTransaction.
`protected void`	`doResume(Object transaction, 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 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, i.e. already begun, transaction.
`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, 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

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.

See Also:: LocalDataSourceConnectionProvider, LocalSessionFactoryBean.setDataSource(javax.sql.DataSource), DataSourceUtils.getConnection(javax.sql.DataSource), JdbcTemplate

getDataSource

public DataSource getDataSource()

Return the JDBC DataSource that this instance manages transactions for.

getPersistenceBroker

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

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

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

Returns:: the PersistenceBroker
See Also:: setJcdAlias(java.lang.String), setPbKey(org.apache.ojb.broker.PBKey), OjbFactoryUtils.getPersistenceBroker(org.apache.ojb.broker.PBKey, boolean)

closePersistenceBrokerIfNecessary

protected void closePersistenceBrokerIfNecessary(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.closePersistenceBrokerIfNecessary(org.apache.ojb.broker.PersistenceBroker, org.apache.ojb.broker.PBKey)