Class TransactionAwareConnectionFactoryProxy

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

public class TransactionAwareConnectionFactoryProxy extends Object implements ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory
Proxy for a target JMS ConnectionFactory, adding awareness of Spring-managed transactions. Similar to a transactional JNDI ConnectionFactory as provided by a Jakarta EE application 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 (for example, to perform manual transaction control). For typical application purposes, simply use the standard JMS Session interface.

As of Spring Framework 5, this class delegates JMS 2.0 JMSContext calls and therefore requires the JMS 2.0 API to be present at runtime. It may nevertheless run against a JMS 1.1 driver (bound to the JMS 2.0 API) as long as no actual JMS 2.0 calls are triggered by the application's setup.

Since:
2.0
Author:
Juergen Hoeller
See Also:
  • Constructor Details

    • TransactionAwareConnectionFactoryProxy

      public TransactionAwareConnectionFactoryProxy()
      Create a new TransactionAwareConnectionFactoryProxy.
    • TransactionAwareConnectionFactoryProxy

      public TransactionAwareConnectionFactoryProxy(ConnectionFactory targetConnectionFactory)
      Create a new TransactionAwareConnectionFactoryProxy.
      Parameters:
      targetConnectionFactory - the target ConnectionFactory
  • Method Details