Package com.adaptris.xa.jms

Class XAJmsConsumerImpl

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.xa.jms.XAJmsConsumerImpl

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, JmsActorConfig, LicensedComponent, MessageEventGenerator, StateManagedComponent

Direct Known Subclasses:

XAJmsConsumer

public abstract class XAJmsConsumerImpl
extends AdaptrisMessageConsumerImp
implements JmsActorConfig, LicensedComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.util.concurrent.locks.ReentrantLock	consumeLock
protected javax.jms.MessageConsumer	consumer
protected java.lang.String	currentTxId
protected java.util.concurrent.ScheduledExecutorService	executor
protected java.util.concurrent.ScheduledFuture<?>	pollerTask
protected javax.jms.XASession	session

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
XAJmsConsumerImpl()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	beginTransaction()
void	close()
protected boolean	commitTransaction()
protected boolean	commitTransaction(int messageNumber)
int	configuredAcknowledgeMode()
CorrelationIdSource	configuredCorrelationIdSource()
AdaptrisMessageListener	configuredMessageListener()
MessageTypeTranslator	configuredMessageTranslator()
java.lang.String	consumeLocationKey()	Provides the metadata key "JMSDestination" which will only be populated if MessageTypeTranslatorImp.getMoveJmsHeaders() is true.
protected abstract javax.jms.MessageConsumer	createConsumer()
org.slf4j.Logger	currentLogger()
javax.jms.Session	currentSession()
protected java.lang.String	endpoint()
javax.jms.MessageConsumer	getConsumer()
@NotNull CorrelationIdSource	getCorrelationIdSource()
java.lang.String	getEndpoint()	The RFC6167 format topic/queue.
java.lang.Boolean	getGlobalLock()
@javax.validation.constraints.NotNull int	getMaxBatch()
@NotNull TimeInterval	getMaxTransactionTime()
java.lang.String	getMessageSelector()	The message selector to use when matching messages to consume
int	getMessagesInCurrentTransaction()
@NotNull @NonNull MessageTypeTranslator	getMessageTranslator()
protected XAOnMessageHandler	getOnMessageHandler()
@NotNull TimeInterval	getReceiveWait()
java.lang.Boolean	getRecreateConsumerOnError()
TransactionManager	getTransactionManager()
@NotNull com.adaptris.xa.jms.exception.XAExceptionHandler	getXaExceptionHandler()
@NotNull @NonNull java.lang.String	getXaResourceName()	Name to enlist a resource to the transaction manager.
protected boolean	globalLock()
protected void	handleException(java.lang.Exception ex)
protected void	handleXAException(java.lang.Exception exception)
void	init()
boolean	isEnabled(License license)
boolean	isManagedTransaction()
protected java.lang.String	messageSelector()
protected java.lang.String	newThreadName()
void	prepare()
protected void	processXAMessages()
protected boolean	rollbackIfRequired()	If the current transaction has been marked rollback only, lets do that.
long	rollbackTimeout()
protected void	rollbackTransaction(boolean expected)
void	setConsumer(javax.jms.MessageConsumer consumer)
void	setCorrelationIdSource(@NotNull CorrelationIdSource correlationIdSource)
void	setEndpoint(java.lang.String endpoint)	The RFC6167 format topic/queue.
void	setGlobalLock(java.lang.Boolean globalLock)
void	setMaxBatch(@javax.validation.constraints.NotNull int maxBatch)
void	setMaxTransactionTime(@NotNull TimeInterval maxTransactionTime)
void	setMessageSelector(java.lang.String messageSelector)	The message selector to use when matching messages to consume
void	setMessagesInCurrentTransaction(int messagesInCurrentTransaction)
void	setMessageTranslator(@NotNull @NonNull MessageTypeTranslator messageTranslator)
protected void	setOnMessageHandler(XAOnMessageHandler onMessageHandler)
void	setReceiveWait(@NotNull TimeInterval receiveWait)
void	setRecreateConsumerOnError(java.lang.Boolean recreateConsumerOnError)
void	setTransactionManager(TransactionManager transactionManager)
void	setXaExceptionHandler(@NotNull com.adaptris.xa.jms.exception.XAExceptionHandler xaExceptionHandler)
void	setXaResourceName(@NotNull @NonNull java.lang.String xaResourceName)	Name to enlist a resource to the transaction manager.
void	start()
protected void	startProcessing()
void	stop()
<T extends XAJmsConsumerImpl> T	withEndpoint(java.lang.String s)

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

Field Detail

consumer

protected transient javax.jms.MessageConsumer consumer

session

protected transient javax.jms.XASession session

executor

protected transient java.util.concurrent.ScheduledExecutorService executor

pollerTask

protected transient java.util.concurrent.ScheduledFuture<?> pollerTask

currentTxId

protected transient java.lang.String currentTxId

consumeLock

protected static final java.util.concurrent.locks.ReentrantLock consumeLock

Constructor Detail

XAJmsConsumerImpl

public XAJmsConsumerImpl()

Creates a new instance. Default session type is client acknowledge, default JMS message type is text.

Method Detail

createConsumer

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

Throws:

javax.jms.JMSException

CoreException

startProcessing

protected void startProcessing()

processXAMessages

protected void processXAMessages()

handleXAException

protected void handleXAException(java.lang.Exception exception)

rollbackIfRequired

protected boolean rollbackIfRequired()

If the current transaction has been marked rollback only, lets do that.

handleException

protected void handleException(java.lang.Exception ex)

beginTransaction

protected void beginTransaction()
                         throws java.lang.Exception

Throws:

java.lang.Exception

commitTransaction

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

Throws:

java.lang.Exception

commitTransaction

protected boolean commitTransaction()
                             throws java.lang.Exception

Throws:

java.lang.Exception

rollbackTransaction

protected void rollbackTransaction(boolean expected)

close

public void close()

Specified by:

close in interface ComponentLifecycle

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

isEnabled

public boolean isEnabled(License license)

Specified by:

isEnabled in interface LicensedComponent

configuredAcknowledgeMode

public int configuredAcknowledgeMode()

Specified by:

configuredAcknowledgeMode in interface JmsActorConfig

configuredCorrelationIdSource

public CorrelationIdSource configuredCorrelationIdSource()

Specified by:

configuredCorrelationIdSource in interface JmsActorConfig

configuredMessageListener

public AdaptrisMessageListener configuredMessageListener()

Specified by:

configuredMessageListener in interface JmsActorConfig

configuredMessageTranslator

public MessageTypeTranslator configuredMessageTranslator()

Specified by:

configuredMessageTranslator in interface JmsActorConfig

currentLogger

public org.slf4j.Logger currentLogger()

Specified by:

currentLogger in interface JmsActorConfig

currentSession

public javax.jms.Session currentSession()

Specified by:

currentSession in interface JmsActorConfig

isManagedTransaction

public boolean isManagedTransaction()

Specified by:

isManagedTransaction in interface JmsActorConfig

rollbackTimeout

public long rollbackTimeout()

Specified by:

rollbackTimeout in interface JmsActorConfig

globalLock

protected boolean globalLock()

getMessagesInCurrentTransaction

public int getMessagesInCurrentTransaction()

setMessagesInCurrentTransaction

public void setMessagesInCurrentTransaction(int messagesInCurrentTransaction)

getOnMessageHandler

protected XAOnMessageHandler getOnMessageHandler()

setOnMessageHandler

protected void setOnMessageHandler(XAOnMessageHandler onMessageHandler)

getConsumer

public javax.jms.MessageConsumer getConsumer()

setConsumer

public void setConsumer(javax.jms.MessageConsumer consumer)

consumeLocationKey

public java.lang.String consumeLocationKey()

Provides the metadata key "JMSDestination" which will only be populated if MessageTypeTranslatorImp.getMoveJmsHeaders() is true.

Specified by:

consumeLocationKey in interface AdaptrisMessageConsumer

Since:

3.9.0

withEndpoint

public <T extends XAJmsConsumerImpl> T withEndpoint(java.lang.String s)

messageSelector

protected java.lang.String messageSelector()

endpoint

protected java.lang.String endpoint()

newThreadName

protected java.lang.String newThreadName()

Overrides:

newThreadName in class AdaptrisMessageConsumerImp

getMaxBatch

@NotNull
public @javax.validation.constraints.NotNull int getMaxBatch()

setMaxBatch

public void setMaxBatch(@NotNull
                        @javax.validation.constraints.NotNull int maxBatch)

getMessageTranslator

@NotNull
@NonNull
public @NotNull @NonNull MessageTypeTranslator getMessageTranslator()

setMessageTranslator

public void setMessageTranslator(@NotNull @NonNull
                                 @NotNull @NonNull MessageTypeTranslator messageTranslator)

getCorrelationIdSource

@NotNull
public @NotNull CorrelationIdSource getCorrelationIdSource()

setCorrelationIdSource

public void setCorrelationIdSource(@NotNull
                                   @NotNull CorrelationIdSource correlationIdSource)

getReceiveWait

@NotNull
public @NotNull TimeInterval getReceiveWait()

setReceiveWait

public void setReceiveWait(@NotNull
                           @NotNull TimeInterval receiveWait)

getMaxTransactionTime

@NotNull
public @NotNull TimeInterval getMaxTransactionTime()

setMaxTransactionTime

public void setMaxTransactionTime(@NotNull
                                  @NotNull TimeInterval maxTransactionTime)

getXaResourceName

@NotNull
@NonNull
public @NotNull @NonNull java.lang.String getXaResourceName()

Name to enlist a resource to the transaction manager. Must be globally unique. A UUID is used if left empty.

setXaResourceName

public void setXaResourceName(@NotNull @NonNull
                              @NotNull @NonNull java.lang.String xaResourceName)

Name to enlist a resource to the transaction manager. Must be globally unique. A UUID is used if left empty.

getTransactionManager

public TransactionManager getTransactionManager()

setTransactionManager

public void setTransactionManager(TransactionManager transactionManager)

getXaExceptionHandler

@NotNull
public @NotNull com.adaptris.xa.jms.exception.XAExceptionHandler getXaExceptionHandler()

setXaExceptionHandler

public void setXaExceptionHandler(@NotNull
                                  @NotNull com.adaptris.xa.jms.exception.XAExceptionHandler xaExceptionHandler)

getRecreateConsumerOnError

public java.lang.Boolean getRecreateConsumerOnError()

setRecreateConsumerOnError

public void setRecreateConsumerOnError(java.lang.Boolean recreateConsumerOnError)

getGlobalLock

public java.lang.Boolean getGlobalLock()

setGlobalLock

public void setGlobalLock(java.lang.Boolean globalLock)

getEndpoint

public java.lang.String getEndpoint()

The RFC6167 format topic/queue.

setEndpoint

public void setEndpoint(java.lang.String endpoint)

The RFC6167 format topic/queue.

getMessageSelector

public java.lang.String getMessageSelector()

The message selector to use when matching messages to consume

setMessageSelector

public void setMessageSelector(java.lang.String messageSelector)

The message selector to use when matching messages to consume