org.apache.commons.messagelet

Class XAConsumerThread

java.lang.Object

java.lang.Thread

org.apache.commons.messagelet.ConsumerThread

org.apache.commons.messagelet.XAConsumerThread

All Implemented Interfaces:

java.lang.Runnable

public class XAConsumerThread
extends ConsumerThread

XAConsumerThread is a thread which will perform XA processing of messages

Version:

$Revision: 1.5 $

Author:

damon.hamacha, James Strachan

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.commons.logging.Log	log Logger
private javax.transaction.Transaction	transaction
private javax.transaction.TransactionManager	transctionManager

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
XAConsumerThread()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cancelTransaction() Strategy method to represent the code required to cancel a transaction.
protected void	commitTransaction() Strategy method to represent the code required to commit a transaction.
protected javax.transaction.TransactionManager	createTransactionManager() Factory method to create a TransactionManager via some mechanism.
protected void	delist(javax.transaction.Transaction transaction, int flag) Delists any resources from the current transaction.
protected void	enlist(javax.transaction.Transaction transaction) Enlists any resources with the current transaction.
javax.transaction.TransactionManager	getTransactionManager()
protected XACapable	getXACapable(Messenger messenger)
protected void	rollbackTransaction() Strategy method to represent the code required to rollback a transaction.
void	setTransactionManager(javax.transaction.TransactionManager transctionManager) Sets the transaction manager to be used
protected void	startTransaction() Strategy method to represent the code required to start a transaction.

Methods inherited from class org.apache.commons.messagelet.ConsumerThread

createConsumer, getConsumer, getDestination, getListener, getMessenger, getSelector, isShouldStop, processMessage, rollbackTransaction, run, setDestination, setListener, setMessenger, setSelector, setShouldStop, startConsumer, stopConsumer

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

Logger

transctionManager

private javax.transaction.TransactionManager transctionManager

transaction

private javax.transaction.Transaction transaction

Constructor Detail

XAConsumerThread

public XAConsumerThread()

Method Detail

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()
                                                           throws javax.transaction.SystemException

Returns:

the TransactionManager to be used

Throws:

javax.transaction.SystemException

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager transctionManager)

Sets the transaction manager to be used

Parameters:

transctionManager - the transaction manager to be used

createTransactionManager

protected javax.transaction.TransactionManager createTransactionManager()
                                                                 throws javax.transaction.SystemException

Factory method to create a TransactionManager via some mechanism. By default this mechanism will lookup in JNDI

Throws:

javax.transaction.SystemException

enlist

protected void enlist(javax.transaction.Transaction transaction)
               throws java.lang.Exception

Enlists any resources with the current transaction. Typically the input Messenger's Session will always be enlisted. Then if the current MessageListener implements XACapable then any of its resources will also be enlisted.

Parameters:

transaction - the transaction to enlist resources with

Throws:

java.lang.Exception - if the enlistment fails for whatever reason

delist

protected void delist(javax.transaction.Transaction transaction,
          int flag)
               throws java.lang.Exception

Delists any resources from the current transaction. This includes the current input Messenger's Session as well as any resources used by the MessageListener if it implements XACapable

Parameters:

transaction -

flag - is the flag used by JTA when delisting resources. It is either XAResource.TMSUCCESS, XAResource.TMSUSPEND, or XAResource.TMFAIL

Throws:

java.lang.Exception

startTransaction

protected void startTransaction()
                         throws java.lang.Exception

Strategy method to represent the code required to start a transaction.

Overrides:

startTransaction in class ConsumerThread

Throws:

java.lang.Exception

commitTransaction

protected void commitTransaction()
                          throws java.lang.Exception

Strategy method to represent the code required to commit a transaction.

Overrides:

commitTransaction in class ConsumerThread

Throws:

java.lang.Exception

rollbackTransaction

protected void rollbackTransaction()
                            throws java.lang.Exception

Strategy method to represent the code required to rollback a transaction.

Throws:

java.lang.Exception

cancelTransaction

protected void cancelTransaction()
                          throws java.lang.Exception

Strategy method to represent the code required to cancel a transaction. This is called when a message is not received.

Overrides:

cancelTransaction in class ConsumerThread

Throws:

java.lang.Exception

getXACapable

protected XACapable getXACapable(Messenger messenger)

Returns:

an XACapable for the given Messenger