public class

TransactionAwareConnectionFactoryProxy

extends Object
java.lang.Object
   ↳ org.springframework.jms.connection.TransactionAwareConnectionFactoryProxy

Class Overview

Proxy for a target JMS javax.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.

See Also

Summary

Public Constructors
TransactionAwareConnectionFactoryProxy()
Create a new TransactionAwareConnectionFactoryProxy.
TransactionAwareConnectionFactoryProxy(ConnectionFactory targetConnectionFactory)
Create a new TransactionAwareConnectionFactoryProxy.
Public Methods
Connection createConnection(String username, String password)
Connection createConnection()
QueueConnection createQueueConnection(String username, String password)
QueueConnection createQueueConnection()
TopicConnection createTopicConnection()
TopicConnection createTopicConnection(String username, String password)
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.
final void setTargetConnectionFactory(ConnectionFactory targetConnectionFactory)
Set the target ConnectionFactory that this ConnectionFactory should delegate to.
Protected Methods
ConnectionFactory getTargetConnectionFactory()
Return the target ConnectionFactory that this ConnectionFactory should delegate to.
Connection getTransactionAwareConnectionProxy(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.
boolean isSynchedLocalTransactionAllowed()
Return whether to allow for a local JMS transaction that is synchronized with a Spring-managed transaction.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public TransactionAwareConnectionFactoryProxy ()

Create a new TransactionAwareConnectionFactoryProxy.

public TransactionAwareConnectionFactoryProxy (ConnectionFactory targetConnectionFactory)

Create a new TransactionAwareConnectionFactoryProxy.

Parameters
targetConnectionFactory the target ConnectionFactory

Public Methods

public Connection createConnection (String username, String password)

Throws
JMSException

public Connection createConnection ()

Throws
JMSException

public QueueConnection createQueueConnection (String username, String password)

Throws
JMSException

public QueueConnection createQueueConnection ()

Throws
JMSException

public TopicConnection createTopicConnection ()

Throws
JMSException

public TopicConnection createTopicConnection (String username, String password)

Throws
JMSException

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.

public final void setTargetConnectionFactory (ConnectionFactory targetConnectionFactory)

Set the target ConnectionFactory that this ConnectionFactory should delegate to.

Protected Methods

protected ConnectionFactory getTargetConnectionFactory ()

Return the target ConnectionFactory that this ConnectionFactory should delegate to.

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

protected boolean isSynchedLocalTransactionAllowed ()

Return whether to allow for a local JMS transaction that is synchronized with a Spring-managed transaction.