Package com.adaptris.xa.jms.async

Class XAJmsConsumerAsync

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.xa.jms.XAJmsConsumerImpl

com.adaptris.xa.jms.XAJmsConsumer

com.adaptris.xa.jms.async.XAJmsConsumerAsync

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, JmsActorConfig, LicensedComponent, MessageEventGenerator, StateManagedComponent, AsyncAware, AsyncConsumerAware, javax.jms.CompletionListener

@ComponentProfile(summary="Listen for JMS messages on the specified queue or topic, with XA transactions.",
                  tag="consumer,jms,xa,async",
                  recommended=com.adaptris.xa.jms.XAJmsConnection.class)
public class XAJmsConsumerAsync
extends XAJmsConsumer
implements AsyncConsumerAware

A JMS consumer that extends the base functionality of the XAJmsConsumer

This differs from the standard XAJmsConsumer by providing support for JMS 2.0 asynchronous callbacks.

This consumer is designed to work with the XAWorkflowAsync and the XAJmsProducerAsync.

The async producer will send messages to your JMS endpoint but will not wait for the acknowledgement before continuing. At some point in the future this JMS consumer will receive an notification for each produced message, indicating if the message has indeed been acknowledged or not.

Once we have consumed/processed the max-batch number of messages, we will then wait for all successful notifications before committing the transaction. Should any of the notifications come back as an error, we will rollback the entire transaction. Additionally if we wait longer than the configured max-wait-for-batch-callbacks before receiving all successful notifications, then again the entire transaction is rolled back.

In the adapter configuration file this class is aliased as xa-jms-consumer-async which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.xa.jms.XAJmsConsumerImpl

consumeLock, consumer, currentTxId, executor, pollerTask, session

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
XAJmsConsumerAsync()

Method Summary

Modifier and Type	Method	Description
protected void	beginTransaction()
protected boolean	commitTransaction()
protected boolean	commitTransaction(int messageNumber)
protected javax.jms.MessageConsumer	createConsumer()
int	getCompletedMessages()
java.lang.Long	getMaxWaitForBatchCallbacks()	Gets the maximum wait time in milliseconds for each transaction to wait for successful async produced message callbacks.
java.lang.Long	getWaitPollIntervalMillis()	While waiting for all asynchronous produced message callbacks, this value determines how often, in milliseconds we check all callbacks have been received.
java.lang.Long	maxWaitForBatchCallbacks()
void	onCompletion(javax.jms.Message message)
void	onException(javax.jms.Message message, java.lang.Exception exception)
protected void	processXAMessages()
void	setCompletedMessages(int completedMessages)
void	setMaxWaitForBatchCallbacks(java.lang.Long maxWaitForBatchCallbacks)	Sets the maximum wait time in milliseconds for each transaction to wait for successful async produced message callbacks.
void	setWaitPollIntervalMillis(java.lang.Long waitPollIntervalMillis)	While waiting for all asynchronous produced message callbacks, this value determines how often, in milliseconds we check all callbacks have been received.
protected java.lang.Long	waitPollIntervalMillis()

Methods inherited from class com.adaptris.xa.jms.XAJmsConsumerImpl

close, configuredAcknowledgeMode, configuredCorrelationIdSource, configuredMessageListener, configuredMessageTranslator, consumeLocationKey, currentLogger, currentSession, endpoint, getConsumer, getCorrelationIdSource, getEndpoint, getGlobalLock, getMaxBatch, getMaxTransactionTime, getMessageSelector, getMessagesInCurrentTransaction, getMessageTranslator, getOnMessageHandler, getReceiveWait, getRecreateConsumerOnError, getTransactionManager, getXaExceptionHandler, getXaResourceName, globalLock, handleException, handleXAException, init, isEnabled, isManagedTransaction, messageSelector, newThreadName, prepare, rollbackIfRequired, rollbackTimeout, rollbackTransaction, setConsumer, setCorrelationIdSource, setEndpoint, setGlobalLock, setMaxBatch, setMaxTransactionTime, setMessageSelector, setMessagesInCurrentTransaction, setMessageTranslator, setOnMessageHandler, setReceiveWait, setRecreateConsumerOnError, setTransactionManager, setXaExceptionHandler, setXaResourceName, start, startProcessing, stop, withEndpoint

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

XAJmsConsumerAsync

public XAJmsConsumerAsync()

Method Detail

processXAMessages

protected void processXAMessages()

Overrides:

processXAMessages in class XAJmsConsumerImpl

commitTransaction

protected boolean commitTransaction(int messageNumber)
                             throws java.lang.Exception

Overrides:

commitTransaction in class XAJmsConsumerImpl

Throws:

java.lang.Exception

commitTransaction

protected boolean commitTransaction()
                             throws java.lang.Exception

Overrides:

commitTransaction in class XAJmsConsumerImpl

Throws:

java.lang.Exception

onCompletion

public void onCompletion(javax.jms.Message message)

Specified by:

onCompletion in interface javax.jms.CompletionListener

onException

public void onException(javax.jms.Message message,
                        java.lang.Exception exception)

Specified by:

onException in interface javax.jms.CompletionListener

beginTransaction

protected void beginTransaction()
                         throws java.lang.Exception

Overrides:

beginTransaction in class XAJmsConsumerImpl

Throws:

java.lang.Exception

createConsumer

protected javax.jms.MessageConsumer createConsumer()
                                            throws javax.jms.JMSException,
                                                   CoreException

Overrides:

createConsumer in class XAJmsConsumer

Throws:

javax.jms.JMSException

CoreException

maxWaitForBatchCallbacks

public java.lang.Long maxWaitForBatchCallbacks()

getMaxWaitForBatchCallbacks

public java.lang.Long getMaxWaitForBatchCallbacks()

Gets the maximum wait time in milliseconds for each transaction to wait for successful async produced message callbacks.

setMaxWaitForBatchCallbacks

public void setMaxWaitForBatchCallbacks(java.lang.Long maxWaitForBatchCallbacks)

Sets the maximum wait time in milliseconds for each transaction to wait for successful async produced message callbacks.

Parameters:

maxWaitForBatchCallbacks -

getCompletedMessages

public int getCompletedMessages()

setCompletedMessages

public void setCompletedMessages(int completedMessages)

waitPollIntervalMillis

protected java.lang.Long waitPollIntervalMillis()

getWaitPollIntervalMillis

public java.lang.Long getWaitPollIntervalMillis()

While waiting for all asynchronous produced message callbacks, this value determines how often, in milliseconds we check all callbacks have been received.

setWaitPollIntervalMillis

public void setWaitPollIntervalMillis(java.lang.Long waitPollIntervalMillis)

While waiting for all asynchronous produced message callbacks, this value determines how often, in milliseconds we check all callbacks have been received.

Parameters:

waitPollIntervalMillis -