Spring Framework

org.springframework.jms.connection
Class TransactionAwareConnectionFactoryProxy

java.lang.Object
  extended by org.springframework.jms.connection.TransactionAwareConnectionFactoryProxy
All Implemented Interfaces:
javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory

public class TransactionAwareConnectionFactoryProxy
extends java.lang.Object
implements javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory

Proxy for a target JMS ConnectionFactory, adding awareness of Spring-managed transactions. Similar to a transactional JNDI ConnectionFactory as provided by a J2EE server.

Messaging code which should remain unaware of Spring's JMS support can work with this proxy to seamlessly participate in Spring-managed transactions. Note that the transaction manager, for example JmsTransactionManager, still needs to work with the underlying ConnectionFactory, not with this proxy.

Make sure that TransactionAwareConnectionFactoryProxy is the outermost ConnectionFactory of a chain of ConnectionFactory proxies/adapters. TransactionAwareConnectionFactoryProxy can delegate either directly to the target factory or to some intermediary adapter like UserCredentialsConnectionFactoryAdapter.

Delegates to ConnectionFactoryUtils for automatically participating in thread-bound transactions, for example managed by JmsTransactionManager. createSession calls and close calls on returned Sessions will behave properly within a transaction, that is, always work on the transactional Session. If not within a transaction, normal ConnectionFactory behavior applies.

Note that transactional JMS Sessions will be registered on a per-Connection basis. To share the same JMS Session across a transaction, make sure that you operate on the same JMS Connection handle - either through reusing the handle or through configuring a SingleConnectionFactory underneath.

Returned transactional Session proxies will implement the SessionProxy interface to allow for access to the underlying target Session. This is only intended for accessing vendor-specific Session API or for testing purposes (e.g. to perform manual transaction control). For typical application purposes, simply use the standard JMS Session interface.

Since:
2.0
Author:
Juergen Hoeller
See Also:
UserCredentialsConnectionFactoryAdapter, SingleConnectionFactory

Constructor Summary
TransactionAwareConnectionFactoryProxy()
          Create a new TransactionAwareConnectionFactoryProxy.
TransactionAwareConnectionFactoryProxy(javax.jms.ConnectionFactory targetConnectionFactory)
          Create a new TransactionAwareConnectionFactoryProxy.
 
Method Summary
 javax.jms.Connection createConnection()
           
 javax.jms.Connection createConnection(java.lang.String username, java.lang.String password)
           
 javax.jms.QueueConnection createQueueConnection()
           
 javax.jms.QueueConnection createQueueConnection(java.lang.String username, java.lang.String password)
           
 javax.jms.TopicConnection createTopicConnection()
           
 javax.jms.TopicConnection createTopicConnection(java.lang.String username, java.lang.String password)
           
protected  javax.jms.ConnectionFactory getTargetConnectionFactory()
          Return the target ConnectionFactory that this ConnectionFactory should delegate to.
protected  javax.jms.Connection getTransactionAwareConnectionProxy(javax.jms.Connection target)
          Wrap the given Connection with a proxy that delegates every method call to it but handles Session lookup in a transaction-aware fashion.
protected  boolean isSynchedLocalTransactionAllowed()
          Return whether to allow for a local JMS transaction that is synchronized with a Spring-managed transaction.
 void setSynchedLocalTransactionAllowed(boolean synchedLocalTransactionAllowed)
          Set whether to allow for a local JMS transaction that is synchronized with a Spring-managed transaction (where the main transaction might be a JDBC-based one for a specific DataSource, for example), with the JMS transaction committing right after the main transaction.
 void setTargetConnectionFactory(javax.jms.ConnectionFactory targetConnectionFactory)
          Set the target ConnectionFactory that this ConnectionFactory should delegate to.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransactionAwareConnectionFactoryProxy

public TransactionAwareConnectionFactoryProxy()
Create a new TransactionAwareConnectionFactoryProxy.


TransactionAwareConnectionFactoryProxy

public TransactionAwareConnectionFactoryProxy(javax.jms.ConnectionFactory targetConnectionFactory)
Create a new TransactionAwareConnectionFactoryProxy.

Parameters:
targetConnectionFactory - the target ConnectionFactory
Method Detail

setTargetConnectionFactory

public final void setTargetConnectionFactory(javax.jms.ConnectionFactory targetConnectionFactory)
Set the target ConnectionFactory that this ConnectionFactory should delegate to.


getTargetConnectionFactory

protected javax.jms.ConnectionFactory getTargetConnectionFactory()
Return the target ConnectionFactory that this ConnectionFactory should delegate to.


setSynchedLocalTransactionAllowed

public void setSynchedLocalTransactionAllowed(boolean synchedLocalTransactionAllowed)
Set whether to allow for a local JMS transaction that is synchronized with a Spring-managed transaction (where the main transaction might be a JDBC-based one for a specific DataSource, for example), with the JMS transaction committing right after the main transaction. If not allowed, the given ConnectionFactory needs to handle transaction enlistment underneath the covers.

Default is "false": If not within a managed transaction that encompasses the underlying JMS ConnectionFactory, standard Sessions will be returned. Turn this flag on to allow participation in any Spring-managed transaction, with a local JMS transaction synchronized with the main transaction.


isSynchedLocalTransactionAllowed

protected boolean isSynchedLocalTransactionAllowed()
Return whether to allow for a local JMS transaction that is synchronized with a Spring-managed transaction.


createConnection

public javax.jms.Connection createConnection()
                                      throws javax.jms.JMSException
Specified by:
createConnection in interface javax.jms.ConnectionFactory
Throws:
javax.jms.JMSException

createConnection

public javax.jms.Connection createConnection(java.lang.String username,
                                             java.lang.String password)
                                      throws javax.jms.JMSException
Specified by:
createConnection in interface javax.jms.ConnectionFactory
Throws:
javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection()
                                                throws javax.jms.JMSException
Specified by:
createQueueConnection in interface javax.jms.QueueConnectionFactory
Throws:
javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection(java.lang.String username,
                                                       java.lang.String password)
                                                throws javax.jms.JMSException
Specified by:
createQueueConnection in interface javax.jms.QueueConnectionFactory
Throws:
javax.jms.JMSException

createTopicConnection

public javax.jms.TopicConnection createTopicConnection()
                                                throws javax.jms.JMSException
Specified by:
createTopicConnection in interface javax.jms.TopicConnectionFactory
Throws:
javax.jms.JMSException

createTopicConnection

public javax.jms.TopicConnection createTopicConnection(java.lang.String username,
                                                       java.lang.String password)
                                                throws javax.jms.JMSException
Specified by:
createTopicConnection in interface javax.jms.TopicConnectionFactory
Throws:
javax.jms.JMSException

getTransactionAwareConnectionProxy

protected javax.jms.Connection getTransactionAwareConnectionProxy(javax.jms.Connection target)
Wrap the given Connection with a proxy that delegates every method call to it but handles Session lookup in a transaction-aware fashion.

Parameters:
target - the original Connection to wrap
Returns:
the wrapped Connection

Spring Framework