public class

CciLocalTransactionManager

extends AbstractPlatformTransactionManager
implements InitializingBean ResourceTransactionManager
java.lang.Object
   ↳ org.springframework.transaction.support.AbstractPlatformTransactionManager
     ↳ org.springframework.jca.cci.connection.CciLocalTransactionManager

Class Overview

PlatformTransactionManager implementation that manages local transactions for a single CCI ConnectionFactory. Binds a CCI Connection from the specified ConnectionFactory to the thread, potentially allowing for one thread-bound Connection per ConnectionFactory.

Application code is required to retrieve the CCI Connection via getConnection(ConnectionFactory) instead of a standard J2EE-style ConnectionFactory#getConnection() call. Spring classes such as CciTemplate use this strategy implicitly. If not used in combination with this transaction manager, the ConnectionFactoryUtils 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 J2EE lookup pattern ConnectionFactory#getConnection(), for example for legacy code that is not aware of Spring at all. In that case, define a TransactionAwareConnectionFactoryProxy for your target ConnectionFactory, which will automatically participate in Spring-managed transactions.

See Also

Summary

[Expand]
Inherited Constants
From class org.springframework.transaction.support.AbstractPlatformTransactionManager
[Expand]
Inherited Fields
From class org.springframework.transaction.support.AbstractPlatformTransactionManager
Public Constructors
CciLocalTransactionManager()
Create a new CciLocalTransactionManager instance.
CciLocalTransactionManager(ConnectionFactory connectionFactory)
Create a new CciLocalTransactionManager instance.
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
ConnectionFactory getConnectionFactory()
Return the CCI ConnectionFactory that this instance manages local transactions for.
Object getResourceFactory()
Return the resource factory that this transaction manager operates on, e.g.
void setConnectionFactory(ConnectionFactory cf)
Set the CCI ConnectionFactory that this instance should manage local transactions for.
Protected Methods
void doBegin(Object transaction, TransactionDefinition definition)
Begin a new transaction with semantics according to the given transaction definition.
void doCleanupAfterCompletion(Object transaction)
Cleanup resources after transaction completion.
void doCommit(DefaultTransactionStatus status)
Perform an actual commit of the given transaction.
Object doGetTransaction()
Return a transaction object for the current transaction state.
void doResume(Object transaction, Object suspendedResources)
Resume the resources of the current transaction.
void doRollback(DefaultTransactionStatus status)
Perform an actual rollback of the given transaction.
void doSetRollbackOnly(DefaultTransactionStatus status)
Set the given transaction rollback-only.
Object doSuspend(Object transaction)
Suspend the resources of the current transaction.
boolean isExistingTransaction(Object transaction)
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
boolean isRollbackOnly(Object transaction)
[Expand]
Inherited Methods
From class org.springframework.transaction.support.AbstractPlatformTransactionManager
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.transaction.PlatformTransactionManager
From interface org.springframework.transaction.support.ResourceTransactionManager

Public Constructors

public CciLocalTransactionManager ()

Create a new CciLocalTransactionManager instance. A ConnectionFactory has to be set to be able to use it.

See Also

public CciLocalTransactionManager (ConnectionFactory connectionFactory)

Create a new CciLocalTransactionManager instance.

Parameters
connectionFactory CCI ConnectionFactory to manage local transactions for

Public Methods

public void afterPropertiesSet ()

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.

public ConnectionFactory getConnectionFactory ()

Return the CCI ConnectionFactory that this instance manages local transactions for.

public Object getResourceFactory ()

Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.

This target resource factory is usually used as resource key for TransactionSynchronizationManager's resource bindings per thread.

Returns
  • the target resource factory (never null)

public void setConnectionFactory (ConnectionFactory cf)

Set the CCI ConnectionFactory that this instance should manage local transactions for.

Protected Methods

protected void doBegin (Object transaction, TransactionDefinition definition)

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.

Parameters
transaction transaction object returned by doGetTransaction
definition TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name

protected void doCleanupAfterCompletion (Object transaction)

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.

Parameters
transaction transaction object returned by doGetTransaction

protected void doCommit (DefaultTransactionStatus status)

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.

Parameters
status the status representation of the transaction

protected Object doGetTransaction ()

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.

Returns
  • the current transaction object

protected void doResume (Object transaction, Object suspendedResources)

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.

Parameters
transaction transaction object returned by doGetTransaction
suspendedResources the object that holds suspended resources, as returned by doSuspend

protected void doRollback (DefaultTransactionStatus status)

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.

Parameters
status the status representation of the transaction

protected void doSetRollbackOnly (DefaultTransactionStatus status)

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.

Parameters
status the status representation of the transaction

protected Object doSuspend (Object transaction)

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.

Parameters
transaction transaction object returned by doGetTransaction
Returns
  • an object that holds suspended resources (will be kept unexamined for passing it into doResume)

protected boolean isExistingTransaction (Object transaction)

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.

Parameters
transaction transaction object returned by doGetTransaction
Returns
  • if there is an existing transaction

protected boolean isRollbackOnly (Object transaction)

Throws
TransactionException