JmsTransactionManager (Spring Framework)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.jms.connection
Class JmsTransactionManager

java.lang.Object
  org.springframework.transaction.support.AbstractPlatformTransactionManager
      org.springframework.jms.connection.JmsTransactionManager

All Implemented Interfaces:: PlatformTransactionManager, Serializable

Direct Known Subclasses:: JmsTransactionManager102

public class JmsTransactionManager
extends AbstractPlatformTransactionManager

PlatformTransactionManager implementation for a single JMS ConnectionFactory. Binds a JMS Connection/Session pair from the specified ConnectionFactory to the thread, potentially allowing for one thread session per connection factory.

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. It is not able to provide XA transactions, for example to share transactions with data access.

JmsTemplate will auto-detect such thread-bound connection/session pairs and automatically participate in them. There is currently no support for letting plain JMS code participate in such transactions.

This transaction strategy will typically be used in combination with SingleConnectionFactory, which uses a single JMS connection for all JMS access to save resources, typically in a standalone application. Each transaction will then use the same JMS Connection but its own JMS Session.

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.

Since:: 1.1
Author:: Juergen Hoeller
See Also:: JmsTemplate, SingleConnectionFactory, Serialized Form

Field Summary

Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary
`JmsTransactionManager()` Create a new JmsTransactionManager for bean-style usage.
`JmsTransactionManager(ConnectionFactory connectionFactory)` Create a new JmsTransactionManager, given a ConnectionFactory.

Method Summary
`void`	`afterPropertiesSet()` Make sure the connection factory has been set.
`protected Connection`	`createConnection()` Create a JMS Connection via this template's ConnectionFactory.
`protected Session`	`createSession(Connection con)` Create a JMS Session for the given Connection.
`protected void`	`doBegin(Object transaction, TransactionDefinition definition)` Begin a new transaction with the given transaction definition.
`protected void`	`doCleanupAfterCompletion(Object transaction)` Cleanup resources after transaction completion.
`protected void`	`doCommit(DefaultTransactionStatus status)` Perform an actual commit on the given transaction.
`protected Object`	`doGetTransaction()` Return a current transaction object, i.e. a JTA UserTransaction.
`protected void`	`doResume(Object transaction, Object suspendedResources)` Resume the resources of the current transaction.
`protected void`	`doRollback(DefaultTransactionStatus status)` Perform an actual rollback on the given transaction.
`protected void`	`doSetRollbackOnly(DefaultTransactionStatus status)` Set the given transaction rollback-only.
`protected Object`	`doSuspend(Object transaction)` Suspend the resources of the current transaction.
`ConnectionFactory`	`getConnectionFactory()` Return the JMS ConnectionFactory that this instance should manage transactions for.
`protected boolean`	`isExistingTransaction(Object transaction)` Check if the given transaction object indicates an existing, i.e. already begun, transaction.
`void`	`setConnectionFactory(ConnectionFactory connectionFactory)` Set the JMS ConnectionFactory that this instance should manage transactions for.

Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

commit, getTransaction, getTransactionSynchronization, isNestedTransactionAllowed, isRollbackOnCommitFailure, rollback, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JmsTransactionManager

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.

JmsTransactionManager

public JmsTransactionManager(ConnectionFactory connectionFactory)

Create a new JmsTransactionManager, given a ConnectionFactory.
Parameters:: connectionFactory - the ConnectionFactory to obtain connections from

Method Detail

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

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

getConnectionFactory

public ConnectionFactory getConnectionFactory()

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

afterPropertiesSet

public void afterPropertiesSet()

Make sure the connection factory has been set.

createConnection

protected Connection createConnection()
                               throws JMSException

Create a JMS Connection via this template's ConnectionFactory.

This implementation uses JMS 1.1 API.

Returns:: the new JMS Connection
Throws:: JMSException - if thrown by JMS API methods

createSession

protected Session createSession(Connection con)
                         throws JMSException

Create a JMS Session for the given Connection.

This implementation uses JMS 1.1 API.

Parameters:: con - the JMS Connection to create a Session for
Returns:: the new JMS Session
Throws:: JMSException - if thrown by JMS API methods