org.springframework.transaction.PlatformTransactionManager implementation for a single JMS jakarta.jms.ConnectionFactory. Binds a JMS Connection/Session pair from the specified ConnectionFactory to the thread, potentially allowing for one thread-bound Session per ConnectionFactory.

This local strategy is an alternative to executing JMS operations within JTA transactions. Its advantage is that it is able to work in any environment, for example a standalone application or a test suite, with any message broker as target. However, this strategy is not able to provide XA transactions, for example in order to share transactions between messaging and database access. A full JTA/XA setup is required for XA transactions, typically using Spring's org.springframework.transaction.jta.JtaTransactionManager as strategy.

Application code is required to retrieve the transactional JMS Session via ConnectionFactoryUtils#getTransactionalSession instead of a standard Jakarta EE-style ConnectionFactory#createConnection() call with subsequent Session creation. Spring's org.springframework.jms.core.JmsTemplate will autodetect a thread-bound Session and automatically participate in it.

Alternatively, you can allow application code to work with the standard Jakarta EE-style lookup pattern on a ConnectionFactory, 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.

The use of CachingConnectionFactory as a target for this transaction manager is strongly recommended. CachingConnectionFactory uses a single JMS Connection for all JMS access in order to avoid the overhead of repeated Connection creation, as well as maintaining a cache of Sessions. Each transaction will then share the same JMS Connection, while still using its own individual JMS Session.

The use of a raw target ConnectionFactory would not only be inefficient because of the lack of resource reuse. It might also lead to strange effects when your JMS driver doesn't accept MessageProducer.close() calls and/or MessageConsumer.close() calls before Session.commit(), with the latter supposed to commit all the messages that have been sent through the producer handle and received through the consumer handle. As a safe general solution, always pass in a CachingConnectionFactory into this transaction manager's "connectionFactory" property.

Transaction synchronization is turned off by default, as this manager might be used alongside a datastore-based Spring transaction manager such as the JDBC org.springframework.jdbc.datasource.DataSourceTransactionManager, which has stronger needs for synchronization.

Modifier and Type	Class and Description
private static class	JmsTransactionManager.JmsTransactionObject JMS transaction object, representing a JmsResourceHolder.
private class	JmsTransactionManager.LazyJmsResourceHolder Lazily initializing variant of `JmsResourceHolder`, initializing a JMS Connection and Session on user access.

Field Summary

Modifier and Type	Field and Description
private ConnectionFactory	connectionFactory
private boolean	lazyResourceRetrieval

Inherited from org.springframework.transaction.support.AbstractPlatformTransactionManager:: logger SYNCHRONIZATION_ALWAYS SYNCHRONIZATION_NEVER SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

Access	Constructor and Description
public	JmsTransactionManager() Create a new JmsTransactionManager for bean-style usage.
public	JmsTransactionManager(ConnectionFactory the ConnectionFactory to obtain connections from connectionFactory) Create a new JmsTransactionManager, given a ConnectionFactory.

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Make sure the ConnectionFactory has been set.
protected Connection	Returns: the new JMS Connection createConnection() Create a JMS Connection via this template's ConnectionFactory.
protected Session	Returns: the new JMS Session createSession(Connection the JMS Connection to create a Session for con) Create a JMS Session for the given Connection.
protected void	doBegin(Object the transaction object returned by `doGetTransaction` transaction, TransactionDefinition a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name definition) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin. Begin a new transaction with semantics according to the given transaction definition.
protected void	doCleanupAfterCompletion(Object the transaction object returned by `doGetTransaction` transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion. Cleanup resources after transaction completion.
protected void	doCommit(DefaultTransactionStatus the status representation of the transaction status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit. Perform an actual commit of the given transaction.
protected Object	doGetTransaction() Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction. Return a transaction object for the current transaction state.
protected void	doResume(Object the transaction object returned by `doGetTransaction` transaction, Object the object that holds suspended resources, as returned by doSuspend suspendedResources) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume. Resume the resources of the current transaction.
protected void	doRollback(DefaultTransactionStatus the status representation of the transaction status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback. Perform an actual rollback of the given transaction.
protected void	doSetRollbackOnly(DefaultTransactionStatus the status representation of the transaction status) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly. Set the given transaction rollback-only.
protected Object	doSuspend(Object the transaction object returned by `doGetTransaction` transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend. Suspend the resources of the current transaction.
public ConnectionFactory	getConnectionFactory() Return the JMS ConnectionFactory that this instance should manage transactions for.
public Object	getResourceFactory() Implements org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory. Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.
protected boolean	isExistingTransaction(Object the transaction object returned by doGetTransaction transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction. Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
protected final ConnectionFactory	Returns: the ConnectionFactory (never `null`) obtainConnectionFactory() Obtain the ConnectionFactory for actual use.
public void	setConnectionFactory(ConnectionFactory cf) Set the JMS ConnectionFactory that this instance should manage transactions for.
public void	setLazyResourceRetrieval(boolean lazyResourceRetrieval) Specify whether this transaction manager should lazily retrieve a JMS Connection and Session on access within a transaction (`true`).

Inherited from org.springframework.transaction.support.AbstractPlatformTransactionManager:: commit determineTimeout getDefaultTimeout getTransaction getTransactionExecutionListeners getTransactionSynchronization invokeAfterCompletion isFailEarlyOnGlobalRollbackOnly isGlobalRollbackOnParticipationFailure isNestedTransactionAllowed isRollbackOnCommitFailure isValidateExistingTransaction prepareForCommit prepareSynchronization registerAfterCompletionWithExistingTransaction resume rollback setDefaultTimeout setFailEarlyOnGlobalRollbackOnly setGlobalRollbackOnParticipationFailure setNestedTransactionAllowed setRollbackOnCommitFailure setTransactionExecutionListeners setTransactionSynchronization setTransactionSynchronizationName setValidateExistingTransaction shouldCommitOnGlobalRollbackOnly suspend triggerBeforeCommit triggerBeforeCompletion useSavepointForNestedTransaction

Field Detail

connectionFactory	back to summary
private ConnectionFactory connectionFactory Annotations @Nullable

lazyResourceRetrieval	back to summary
private boolean lazyResourceRetrieval

Constructor Detail

JmsTransactionManager back to summary

JmsTransactionManager	back to summary
public JmsTransactionManager() Create a new JmsTransactionManager for bean-style usage. Note The ConnectionFactory has to be set before using the instance. This constructor can be used to prepare a JmsTemplate via a BeanFactory, typically setting the ConnectionFactory via setConnectionFactory. Turns off transaction synchronization by default, as this manager might be used alongside a datastore-based Spring transaction manager like DataSourceTransactionManager, which has stronger needs for synchronization. Only one manager is allowed to drive synchronization at any point of time. See Also `setConnectionFactory`, `setTransactionSynchronization`

public JmsTransactionManager()

Create a new JmsTransactionManager for bean-style usage.

Note

The ConnectionFactory has to be set before using the instance. This constructor can be used to prepare a JmsTemplate via a BeanFactory, typically setting the ConnectionFactory via setConnectionFactory.

Turns off transaction synchronization by default, as this manager might be used alongside a datastore-based Spring transaction manager like DataSourceTransactionManager, which has stronger needs for synchronization. Only one manager is allowed to drive synchronization at any point of time.

See Also: setConnectionFactory, setTransactionSynchronization

JmsTransactionManager	back to summary
public JmsTransactionManager(ConnectionFactory connectionFactory) Create a new JmsTransactionManager, given a ConnectionFactory. Parameters connectionFactory:ConnectionFactory the ConnectionFactory to obtain connections from

JmsTransactionManager

back to summary

public JmsTransactionManager(ConnectionFactory connectionFactory)

Create a new JmsTransactionManager, given a ConnectionFactory.

Parameters

connectionFactory:ConnectionFactory: the ConnectionFactory to obtain connections from

Method Detail

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Make sure the ConnectionFactory has been set. Annotations @Override

afterPropertiesSet

back to summary

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Make sure the ConnectionFactory has been set.

Annotations

@Override

createConnection	back to summary
protected Connection createConnection() throws JMSException Create a JMS Connection via this template's ConnectionFactory. This implementation uses JMS 1.1 API. Returns:Connection the new JMS Connection Exceptions JMSException: if thrown by JMS API methods

createConnection

back to summary

protected Connection createConnection() throws JMSException

Create a JMS Connection via this template's ConnectionFactory.

This implementation uses JMS 1.1 API.

Returns:Connection

the new JMS Connection

Exceptions

JMSException:: if thrown by JMS API methods

createSession	back to summary
protected Session createSession(Connection con) throws JMSException Create a JMS Session for the given Connection. This implementation uses JMS 1.1 API. Parameters con:Connection the JMS Connection to create a Session for Returns:Session the new JMS Session Exceptions JMSException: if thrown by JMS API methods

createSession

back to summary

protected Session createSession(Connection con) throws JMSException

Create a JMS Session for the given Connection.

This implementation uses JMS 1.1 API.

Parameters

con:Connection: the JMS Connection to create a Session for

Returns:Session

the new JMS Session

Exceptions

JMSException:: if thrown by JMS API methods

doBegin back to summary

doBegin	back to summary
protected void doBegin(Object transaction, TransactionDefinition definition) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin. 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:Object the transaction object returned by `doGetTransaction` definition:TransactionDefinition a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name Annotations @Override

protected void doBegin(Object transaction, TransactionDefinition definition)

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doBegin.

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:Object: the transaction object returned by doGetTransaction
definition:TransactionDefinition: a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name

Annotations

@Override

doCleanupAfterCompletion back to summary

doCleanupAfterCompletion	back to summary
protected void doCleanupAfterCompletion(Object transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion. 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:Object the transaction object returned by `doGetTransaction` Annotations @Override

protected void doCleanupAfterCompletion(Object transaction)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCleanupAfterCompletion.

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:Object: the transaction object returned by doGetTransaction

Annotations

@Override

doCommit	back to summary
protected void doCommit(DefaultTransactionStatus status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit. 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:DefaultTransactionStatus the status representation of the transaction Annotations @Override

doCommit

back to summary

protected void doCommit(DefaultTransactionStatus status)

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doCommit.

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:DefaultTransactionStatus: the status representation of the transaction

Annotations

@Override

doGetTransaction back to summary

doGetTransaction	back to summary
protected Object doGetTransaction() Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.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:Object the current transaction object Annotations @Override

protected Object doGetTransaction()

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doGetTransaction.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.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:Object

the current transaction object

Annotations

@Override

doResume back to summary

doResume	back to summary
protected void doResume(Object transaction, Object suspendedResources) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume. 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:Object the transaction object returned by `doGetTransaction` suspendedResources:Object the object that holds suspended resources, as returned by doSuspend Annotations @Override

protected void doResume(Object transaction, Object suspendedResources)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doResume.

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:Object: the transaction object returned by doGetTransaction
suspendedResources:Object: the object that holds suspended resources, as returned by doSuspend

Annotations

@Override

doRollback	back to summary
protected void doRollback(DefaultTransactionStatus status) Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback. 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:DefaultTransactionStatus the status representation of the transaction Annotations @Override

doRollback

back to summary

protected void doRollback(DefaultTransactionStatus status)

Implements abstract org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doRollback.

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:DefaultTransactionStatus: the status representation of the transaction

Annotations

@Override

doSetRollbackOnly	back to summary
protected void doSetRollbackOnly(DefaultTransactionStatus status) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly. 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:DefaultTransactionStatus the status representation of the transaction Annotations @Override

doSetRollbackOnly

back to summary

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSetRollbackOnly.

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:DefaultTransactionStatus: the status representation of the transaction

Annotations

@Override

doSuspend back to summary

doSuspend	back to summary
protected Object doSuspend(Object transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend. 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:Object the transaction object returned by `doGetTransaction` Returns:Object an object that holds suspended resources (will be kept unexamined for passing it into doResume) Annotations @Override

protected Object doSuspend(Object transaction)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.doSuspend.

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:Object: the transaction object returned by doGetTransaction

Returns:Object

an object that holds suspended resources (will be kept unexamined for passing it into doResume)

Annotations

@Override

getConnectionFactory	back to summary
public ConnectionFactory getConnectionFactory() Return the JMS ConnectionFactory that this instance should manage transactions for. Annotations @Nullable

getConnectionFactory

back to summary

public ConnectionFactory getConnectionFactory()

Return the JMS ConnectionFactory that this instance should manage transactions for.

Annotations

@Nullable

getResourceFactory back to summary

getResourceFactory	back to summary
public Object getResourceFactory() Implements org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory. Doc from org.springframework.transaction.support.ResourceTransactionManager.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:Object the target resource factory (never `null`) Annotations @Override

public Object getResourceFactory()

Implements org.springframework.transaction.support.ResourceTransactionManager.getResourceFactory.

Doc from org.springframework.transaction.support.ResourceTransactionManager.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:Object

the target resource factory (never null)

Annotations

@Override

isExistingTransaction back to summary

isExistingTransaction	back to summary
protected boolean isExistingTransaction(Object transaction) Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction. Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction. 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:Object the transaction object returned by doGetTransaction Returns:boolean if there is an existing transaction Annotations @Override

protected boolean isExistingTransaction(Object transaction)

Overrides org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction.

Doc from org.springframework.transaction.support.AbstractPlatformTransactionManager.isExistingTransaction.

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:Object: the transaction object returned by doGetTransaction

Returns:boolean

if there is an existing transaction

Annotations

@Override

obtainConnectionFactory back to summary

obtainConnectionFactory	back to summary
protected final ConnectionFactory obtainConnectionFactory() Obtain the ConnectionFactory for actual use. Returns:ConnectionFactory the ConnectionFactory (never `null`) Exceptions IllegalStateException: in case of no ConnectionFactory set Since 5.0

protected final ConnectionFactory obtainConnectionFactory()

Obtain the ConnectionFactory for actual use.

Returns:ConnectionFactory

the ConnectionFactory (never null)

Exceptions

IllegalStateException:: in case of no ConnectionFactory set

Since

5.0

setConnectionFactory	back to summary
public void setConnectionFactory(ConnectionFactory cf) Set the JMS ConnectionFactory that this instance should manage transactions for.

setLazyResourceRetrieval back to summary

setLazyResourceRetrieval	back to summary
public void setLazyResourceRetrieval(boolean lazyResourceRetrieval) Specify whether this transaction manager should lazily retrieve a JMS Connection and Session on access within a transaction (`true`). By default, it will eagerly create a JMS Connection and Session at transaction begin (`false`). Since 5.1.6 See Also `JmsResourceHolder#getConnection()`, `JmsResourceHolder#getSession()`

public void setLazyResourceRetrieval(boolean lazyResourceRetrieval)

Specify whether this transaction manager should lazily retrieve a JMS Connection and Session on access within a transaction (true). By default, it will eagerly create a JMS Connection and Session at transaction begin (false).

Since: 5.1.6
See Also: JmsResourceHolder#getConnection(), JmsResourceHolder#getSession()

Modifier and Type	Field and Description
private JmsResourceHolder	resourceHolder

Access	Constructor and Description
private	JmsTransactionObject()

Modifier and Type	Method and Description
public JmsResourceHolder	getResourceHolder()
public boolean	hasResourceHolder()
public boolean	isRollbackOnly() Overrides default org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly. Return whether the transaction is internally marked as rollback-only.
public void	setResourceHolder(JmsResourceHolder resourceHolder)

resourceHolder	back to summary
private JmsResourceHolder resourceHolder Annotations @Nullable

JmsTransactionObject	back to summary
private JmsTransactionObject()

getResourceHolder	back to summary
public JmsResourceHolder getResourceHolder()

hasResourceHolder	back to summary
public boolean hasResourceHolder()

isRollbackOnly	back to summary
public boolean isRollbackOnly() Overrides default org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly. Doc from org.springframework.transaction.support.SmartTransactionObject.isRollbackOnly. Return whether the transaction is internally marked as rollback-only. Can, for example, check the JTA UserTransaction. The default implementation returns `false`. Annotations @Override

setResourceHolder	back to summary
public void setResourceHolder(JmsResourceHolder resourceHolder)

org.springframework.jms.connection back to summary

private Class JmsTransactionManager.LazyJmsResourceHolder

Class Inheritance

extends JmsResourceHolder

java.lang.Object
org.springframework.transaction.support.ResourceHolderSupport
org.springframework.jms.connection.JmsResourceHolder
org.springframework.jms.connection.JmsTransactionManager.LazyJmsResourceHolder

Lazily initializing variant of JmsResourceHolder, initializing a JMS Connection and Session on user access.

Field Summary

Modifier and Type	Field and Description
private boolean	connectionInitialized
private boolean	sessionInitialized

Constructor Summary

Access	Constructor and Description
public	LazyJmsResourceHolder(ConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method and Description
public Connection	getConnection() Overrides org.springframework.jms.connection.JmsResourceHolder.getConnection. Return this resource holder's default Connection, or `null` if none.
public <C extends Connection> C	getConnection(Class<C> connectionType) Overrides org.springframework.jms.connection.JmsResourceHolder.getConnection. Return this resource holder's Connection of the given type, or `null` if none.
public Session	getSession() Overrides org.springframework.jms.connection.JmsResourceHolder.getSession. Return this resource holder's default Session, or `null` if none.
public <S extends Session> S	getSession(Class<S> sessionType) Overrides org.springframework.jms.connection.JmsResourceHolder.getSession. Return this resource holder's Session of the given type, or `null` if none.
public <S extends Session> S	getSession(Class<S> sessionType, Connection connection) Overrides org.springframework.jms.connection.JmsResourceHolder.getSession. Return this resource holder's Session of the given type for the given connection, or `null` if none.
private void	initializeConnection()
private void	initializeSession()

Inherited from org.springframework.jms.connection.JmsResourceHolder:: addConnection addSession addSession closeAll commitAll containsSession getOriginalSession isFrozen

Field Detail

connectionInitialized	back to summary
private boolean connectionInitialized

sessionInitialized	back to summary
private boolean sessionInitialized

Constructor Detail

LazyJmsResourceHolder	back to summary
public LazyJmsResourceHolder(ConnectionFactory connectionFactory)

Method Detail

getConnection back to summary

getConnection	back to summary
public Connection getConnection() Overrides org.springframework.jms.connection.JmsResourceHolder.getConnection. Doc from org.springframework.jms.connection.JmsResourceHolder.getConnection. Return this resource holder's default Connection, or `null` if none. Annotations @Override @Nullable

public Connection getConnection()

Overrides org.springframework.jms.connection.JmsResourceHolder.getConnection.

Doc from org.springframework.jms.connection.JmsResourceHolder.getConnection.

Return this resource holder's default Connection, or null if none.

Annotations

@Override
@Nullable

getConnection back to summary

getConnection	back to summary
public <C extends Connection> C getConnection(Class<C> connectionType) Overrides org.springframework.jms.connection.JmsResourceHolder.getConnection. Doc from org.springframework.jms.connection.JmsResourceHolder.getConnection. Return this resource holder's Connection of the given type, or `null` if none. Annotations @Override @Nullable

public <C extends Connection> C getConnection(Class<C> connectionType)

Overrides org.springframework.jms.connection.JmsResourceHolder.getConnection.

Doc from org.springframework.jms.connection.JmsResourceHolder.getConnection.

Return this resource holder's Connection of the given type, or null if none.

Annotations

@Override
@Nullable

getSession back to summary

getSession	back to summary
public Session getSession() Overrides org.springframework.jms.connection.JmsResourceHolder.getSession. Doc from org.springframework.jms.connection.JmsResourceHolder.getSession. Return this resource holder's default Session, or `null` if none. Annotations @Override @Nullable

public Session getSession()

Overrides org.springframework.jms.connection.JmsResourceHolder.getSession.

Doc from org.springframework.jms.connection.JmsResourceHolder.getSession.

Return this resource holder's default Session, or null if none.

Annotations

@Override
@Nullable

getSession back to summary

getSession	back to summary
public <S extends Session> S getSession(Class<S> sessionType) Overrides org.springframework.jms.connection.JmsResourceHolder.getSession. Doc from org.springframework.jms.connection.JmsResourceHolder.getSession. Return this resource holder's Session of the given type, or `null` if none. Annotations @Override @Nullable

public <S extends Session> S getSession(Class<S> sessionType)

Overrides org.springframework.jms.connection.JmsResourceHolder.getSession.

Doc from org.springframework.jms.connection.JmsResourceHolder.getSession.

Return this resource holder's Session of the given type, or null if none.

Annotations

@Override
@Nullable

getSession back to summary

getSession	back to summary
public <S extends Session> S getSession(Class<S> sessionType, Connection connection) Overrides org.springframework.jms.connection.JmsResourceHolder.getSession. Doc from org.springframework.jms.connection.JmsResourceHolder.getSession. Return this resource holder's Session of the given type for the given connection, or `null` if none. Annotations @Override @Nullable

public <S extends Session> S getSession(Class<S> sessionType, Connection connection)

Overrides org.springframework.jms.connection.JmsResourceHolder.getSession.

Doc from org.springframework.jms.connection.JmsResourceHolder.getSession.

Return this resource holder's Session of the given type for the given connection, or null if none.

Annotations

@Override
@Nullable

initializeConnection	back to summary
private void initializeConnection()

initializeSession	back to summary
private void initializeSession()

public Class JmsTransactionManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JmsTransactionManager.JmsTransactionObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JmsTransactionManager.LazyJmsResourceHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail