nl.nn.adapterframework.jms

Class PullingJmsListener

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jms.JMSFacade

nl.nn.adapterframework.jms.JmsListenerBase

nl.nn.adapterframework.jms.PullingJmsListener

All Implemented Interfaces:

HasPhysicalDestination, HasSender, IConfigurable, IConfigurationAware, ICorrelatedPullingListener<javax.jms.Message>, IListener<javax.jms.Message>, INamedObject, IPostboxListener<javax.jms.Message>, IPullingListener<javax.jms.Message>, IRedeliveringListener<javax.jms.Message>, IScopeProvider, IWithParameters, IXAEnabled, RunStateEnquiring, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class PullingJmsListener
extends JmsListenerBase
implements IPostboxListener<javax.jms.Message>, ICorrelatedPullingListener<javax.jms.Message>, HasSender, RunStateEnquiring

A true multi-threaded Listener-class.
Since version 4.1, Ibis supports distributed transactions using the XA-protocol. This feature is controlled by the transacted attribute. If this is set to true, received messages are committed or rolled back, possibly together with other actions, by the receiver or the pipeline. In case of a failure, all actions within the transaction are rolled back.

Using jmsTransacted and acknowledgement
If jmsTransacted is set true: it should ensure that a message is received and processed on a both or nothing basis. IBIS will commit the the message, otherwise perform rollback. However using jmsTransacted, IBIS does not bring transactions within the adapters under transaction control, compromising the idea of atomic transactions. In the roll-back situation messages sent to other destinations within the Pipeline are NOT rolled back if jmsTransacted is set true! In the failure situation the message is therefore completely processed, and the roll back does not mean that the processing is rolled back! To obtain the correct (transactional) behaviour, transacted should be used instead of listener.transacted.

Setting listener.acknowledgeMode to "auto" means that messages are allways acknowledged (removed from the queue, regardless of what the status of the Adapter is. "client" means that the message will only be removed from the queue when the state of the Adapter equals the success state. The "dups" mode instructs the session to lazily acknowledge the delivery of the messages. This is likely to result in the delivery of duplicate messages if JMS fails. It should be used by consumers who are tolerant in processing duplicate messages. In cases where the client is tolerant of duplicate messages, some enhancement in performance can be achieved using this mode, since a session has lower overhead in trying to prevent duplicate messages.

The setting for listener.acknowledgeMode will only be processed if the setting for listener.transacted as well as for listener.jmsTransacted is false.

If useReplyTo is set and a replyTo-destination is specified in the message, the JmsListener sends the result of the processing in the pipeline to this destination. Otherwise the result is sent using the (optionally) specified Sender, that in turn sends the message to whatever it is configured to.

Notice: the JmsListener is ONLY capable of processing javax.jms.TextMessages

Since:

4.0.1

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.jms.JMSFacade

JMSFacade.AcknowledgeMode, JMSFacade.DeliveryMode, JMSFacade.DestinationType, JMSFacade.SubscriberType

Field Summary

Fields inherited from class nl.nn.adapterframework.jms.JMSFacade

messagingSource

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
PullingJmsListener()

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult plr, RawMessageWrapper<javax.jms.Message> rawMessageWrapper, PipeLineSession pipeLineSession) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
protected boolean	canGoOn()
void	closeThread(Map<String,Object> threadContext) Finalizes a message receiving thread.
RawMessageWrapper<javax.jms.Message>	getRawMessage(Map<String,Object> threadContext) Retrieves messages from queue or other channel, but does no processing on it.
RawMessageWrapper<javax.jms.Message>	getRawMessage(String correlationId, Map<String,Object> threadContext) Retrieves messages from queue or other channel, but retrieves only messages with the specified correlationId.
protected javax.jms.MessageConsumer	getReceiver(Map<String,Object> threadContext, javax.jms.Session session, String correlationId)
protected javax.jms.Session	getSession(Map<String,Object> threadContext)
Map<String,Object>	openThread() Prepares a thread for receiving messages.
protected void	releaseReceiver(javax.jms.MessageConsumer receiver, String correlationId)
protected void	releaseSession(javax.jms.Session session)
RawMessageWrapper<javax.jms.Message>	retrieveRawMessage(String messageSelector, Map<String,Object> threadContext) Retrieves the first message found from queue or other channel, that matches the specified messageSelector.
protected void	sendReply(PipeLineResult plr, javax.jms.Destination replyTo, String replyCid, long timeToLive, boolean ignoreInvalidDestinationException, Map<String,Object> threadContext, Map<String,Object> properties)
void	SetRunStateEnquirer(RunStateEnquirer enquirer)

Methods inherited from class nl.nn.adapterframework.jms.JmsListenerBase

addParameter, close, configure, extractMessage, extractMessageProperties, getMessageProperties, getParameterList, messageWillBeRedeliveredOnExitStateError, open, prepareReply, prepareReply, setForceMessageIdAsCorrelationId, setReplyDeliveryMode, setReplyDestinationName, setReplyEncodingStyleURI, setReplyMessageTimeToLive, setReplyMessageType, setReplyNamespaceURI, setReplyPriority, setReplySoapAction, setSender, setSoap, setSoapHeaderSessionKey, setTimeout, setTimeOut, setUseReplyTo

Methods inherited from class nl.nn.adapterframework.jms.JMSFacade

checkTransactionManagerValidity, closeSession, createMessage, createSession, extractMessage, extractMessageBody, getAcknowledgeModeEnum, getConnectionFactoryInfo, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getManagedConnectionFactory, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessagingSource, getMessagingSourceFactory, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isSessionsArePooled, logMessageDetails, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAckMode, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setJmsTransacted, setLookupDestination, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, toString, useJms102

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJmsRealm, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IListener

close, configure, extractMessage, open

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.HasSender

getSender

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.IXAEnabled

isTransacted

Constructor Detail

PullingJmsListener

public PullingJmsListener()

Method Detail

getSession

protected javax.jms.Session getSession(Map<String,Object> threadContext)
                                throws ListenerException

Throws:

ListenerException

releaseSession

protected void releaseSession(javax.jms.Session session)
                       throws ListenerException

Throws:

ListenerException

getReceiver

protected javax.jms.MessageConsumer getReceiver(Map<String,Object> threadContext,
                                                javax.jms.Session session,
                                                String correlationId)
                                         throws ListenerException

Throws:

ListenerException

releaseReceiver

protected void releaseReceiver(javax.jms.MessageConsumer receiver,
                               String correlationId)
                        throws ListenerException

Throws:

ListenerException

openThread

@Nonnull
public Map<String,Object> openThread()
                                       throws ListenerException

Description copied from interface: IPullingListener

Prepares a thread for receiving messages. Called once for each thread that will listen for messages.

Specified by:

openThread in interface IPullingListener<javax.jms.Message>

Returns:

the threadContext for this thread. The threadContext is a Map in which thread-specific data can be stored. May not be null, must be a mutable map type.

Throws:

ListenerException

closeThread

public void closeThread(@Nonnull
                        Map<String,Object> threadContext)
                 throws ListenerException

Description copied from interface: IPullingListener

Finalizes a message receiving thread. Called once for each thread that listens for messages, just before IListener.close() is called.

Specified by:

closeThread in interface IPullingListener<javax.jms.Message>

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult plr,
                                  RawMessageWrapper<javax.jms.Message> rawMessageWrapper,
                                  PipeLineSession pipeLineSession)
                           throws ListenerException

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<javax.jms.Message>

Overrides:

afterMessageProcessed in class JmsListenerBase

Throws:

ListenerException

sendReply

protected void sendReply(PipeLineResult plr,
                         javax.jms.Destination replyTo,
                         String replyCid,
                         long timeToLive,
                         boolean ignoreInvalidDestinationException,
                         Map<String,Object> threadContext,
                         Map<String,Object> properties)
                  throws SenderException,
                         ListenerException,
                         NamingException,
                         javax.jms.JMSException,
                         IOException

Overrides:

sendReply in class JmsListenerBase

Throws:

SenderException

ListenerException

NamingException

javax.jms.JMSException

IOException

getRawMessage

public RawMessageWrapper<javax.jms.Message> getRawMessage(@Nonnull
                                                          Map<String,Object> threadContext)
                                                   throws ListenerException

Retrieves messages from queue or other channel, but does no processing on it.

Specified by:

getRawMessage in interface IPullingListener<javax.jms.Message>

Throws:

ListenerException

getRawMessage

public RawMessageWrapper<javax.jms.Message> getRawMessage(String correlationId,
                                                          Map<String,Object> threadContext)
                                                   throws ListenerException,
                                                          TimeoutException

Description copied from interface: ICorrelatedPullingListener

Retrieves messages from queue or other channel, but retrieves only messages with the specified correlationId.

Specified by:

getRawMessage in interface ICorrelatedPullingListener<javax.jms.Message>

Throws:

ListenerException

TimeoutException

retrieveRawMessage

public RawMessageWrapper<javax.jms.Message> retrieveRawMessage(String messageSelector,
                                                               Map<String,Object> threadContext)
                                                        throws ListenerException

Description copied from interface: IPostboxListener

Retrieves the first message found from queue or other channel, that matches the specified messageSelector.

Specified by:

retrieveRawMessage in interface IPostboxListener<javax.jms.Message>

Parameters:

messageSelector - search criteria for messages. Not that the format of the selector changes per listener, for example a JMSListener's messageSelector follows the JMS specification.

threadContext - context in which the method is called

Throws:

ListenerException

See Also:

IPostboxListener.retrieveRawMessage(String, Map)

canGoOn

protected boolean canGoOn()

SetRunStateEnquirer

public void SetRunStateEnquirer(RunStateEnquirer enquirer)

Specified by:

SetRunStateEnquirer in interface RunStateEnquiring