Class TransactionAwareConnectionFactoryProxy

java.lang.Object
org.springframework.jms.connection.TransactionAwareConnectionFactoryProxy
All Implemented Interfaces:
jakarta.jms.ConnectionFactory, jakarta.jms.QueueConnectionFactory, jakarta.jms.TopicConnectionFactory
public class TransactionAwareConnectionFactoryProxy extends Object implements jakarta.jms.ConnectionFactory, jakarta.jms.QueueConnectionFactory, jakarta.jms.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(jakarta.jms.ConnectionFactory targetConnectionFactory)
      Create a new TransactionAwareConnectionFactoryProxy.
      Parameters:
      targetConnectionFactory - the target ConnectionFactory

  • Method Details

    • setTargetConnectionFactory

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

    • getTargetConnectionFactory

      protected jakarta.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 jakarta.jms.Connection createConnection() throws jakarta.jms.JMSException
      Specified by:
      createConnection in interface jakarta.jms.ConnectionFactory
      Throws:
      jakarta.jms.JMSException

    • createConnection

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

    • createQueueConnection

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

    • createQueueConnection

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

    • createTopicConnection

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

    • createTopicConnection

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

    • createContext

      public jakarta.jms.JMSContext createContext()
      Specified by:
      createContext in interface jakarta.jms.ConnectionFactory

    • createContext

      public jakarta.jms.JMSContext createContext(String userName, String password)
      Specified by:
      createContext in interface jakarta.jms.ConnectionFactory

    • createContext

      public jakarta.jms.JMSContext createContext(String userName, String password, int sessionMode)
      Specified by:
      createContext in interface jakarta.jms.ConnectionFactory

    • createContext

      public jakarta.jms.JMSContext createContext(int sessionMode)
      Specified by:
      createContext in interface jakarta.jms.ConnectionFactory

    • getTransactionAwareConnectionProxy

      protected jakarta.jms.Connection getTransactionAwareConnectionProxy(jakarta.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