org.apache.qpid.jms

Class JmsTransactionSynchronization

java.lang.Object

org.apache.qpid.jms.JmsTransactionSynchronization

public abstract class JmsTransactionSynchronization
extends Object

Interface for JmsResources that are part of a running transaction to use to register for notifications of transaction commit and rollback in order to execute specific actions. One such use of this might be for a consumer to register a synchronization when it is closed while it's parent session is still operating inside a transaction. The Consumer can close itself following the commit or rollback of the running Transaction.

Constructor Summary

Constructors

Constructor and Description
JmsTransactionSynchronization()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterCommit() Called after a successful commit of the current Transaction.
void	afterRollback() Called after the current transaction has been rolled back either by a call to rollback or by a failure to complete a commit operation.
boolean	validate(JmsTransactionContext context) Called once before the synchronization is added to the set of synchronizations held for a pending TX.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsTransactionSynchronization

public JmsTransactionSynchronization()

Method Detail

validate

public boolean validate(JmsTransactionContext context)
                 throws Exception

Called once before the synchronization is added to the set of synchronizations held for a pending TX. The caller can check TX state and react accordingly. If the resource finds that is does not need to be added to the TX it can return false to indicate such.

Parameters:

context - reference to the transaction context.

Returns:

true if the synchronization should be added to the TX.

Throws:

Exception - if an error occurs during the event.

afterCommit

public void afterCommit()
                 throws Exception

Called after a successful commit of the current Transaction.

Throws:

Exception - if an error occurs during the event.

afterRollback

public void afterRollback()
                   throws Exception

Called after the current transaction has been rolled back either by a call to rollback or by a failure to complete a commit operation.

Throws:

Exception - if an error occurs during the event.