nl.nn.adapterframework.jms

Class PushingJmsListener

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jms.JMSFacade

nl.nn.adapterframework.jms.JmsListenerBase

nl.nn.adapterframework.jms.PushingJmsListener

All Implemented Interfaces:

HasPhysicalDestination, HasSender, IConfigurable, IConfigurationAware, IKnowsDeliveryCount<javax.jms.Message>, IListener<javax.jms.Message>, INamedObject, IPortConnectedListener<javax.jms.Message>, IPushingListener<javax.jms.Message>, IRedeliveringListener<javax.jms.Message>, IScopeProvider, IThreadCountControllable, IWithParameters, IXAEnabled, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JmsListener

public class PushingJmsListener
extends JmsListenerBase
implements IPortConnectedListener<javax.jms.Message>, IThreadCountControllable, IKnowsDeliveryCount<javax.jms.Message>

JMSListener re-implemented as a pushing listener rather than a pulling listener. The JMS messages have to come in from an external source: an MDB or a Spring message container. This version of the JmsListener supports distributed transactions using the XA-protocol. No special action is required to have the listener join the transaction.

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, set transacted="true" for the enclosing Receiver. Do not use jmsTransacted for any new situation.

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.8

Author:

Tim van der Leeuw

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
PushingJmsListener()

Method Summary

Modifier and Type	Method and Description
void	close() Releases references to serviceQueue and connection.
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
void	decreaseThreadCount()
int	getCurrentThreadCount()
int	getDeliveryCount(javax.jms.Message rawMessage)
IListenerConnector<javax.jms.Message>	getListenerPortConnector()
int	getMaxThreadCount()
void	increaseThreadCount()
boolean	isThreadCountControllable()
boolean	isThreadCountReadable()
void	open() Obtains a connection and a serviceQueue.
void	setCacheMode(IListenerConnector.CacheMode cacheMode)
void	setDestinationName(String destinationName) Name of the JMS destination (queue or topic) to use
void	setPollGuardInterval(long pollGuardInterval) Interval in milliseconds for the poll guard to check whether a successful poll was done by the receive (https://docs.oracle.com/javaee/7/api/javax/jms/messageconsumer.html#receive-long-) since last check.

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

addParameter, afterMessageProcessed, extractMessage, getIdFromRawMessage, getMessageProperties, getParameterList, messageWillBeRedeliveredOnExitStateError, prepareReply, prepareReply, retrieveIdFromMessage, sendReply, 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, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAckMode, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, 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.IPortConnectedListener

checkTransactionManagerValidity, getExceptionListener, getHandler, getReceiver, setReceiver

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

setExceptionListener, setHandler

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

afterMessageProcessed, extractMessage, getIdFromRawMessage

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

PushingJmsListener

public PushingJmsListener()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IListener

configure() is called once at startup of the framework in the configure() method of the owner of this listener. Purpose of this method is to reduce creating connections to databases etc. in the IPullingListener.getRawMessage(Map) method. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener<javax.jms.Message>

Overrides:

configure in class JmsListenerBase

Throws:

ConfigurationException

open

public void open()
          throws ListenerException

Description copied from class: JMSFacade

Obtains a connection and a serviceQueue.

Specified by:

open in interface IListener<javax.jms.Message>

Overrides:

open in class JmsListenerBase

Throws:

ListenerException

close

public void close()

Description copied from class: JMSFacade

Releases references to serviceQueue and connection.

Specified by:

close in interface IListener<javax.jms.Message>

Overrides:

close in class JmsListenerBase

getListenerPortConnector

public IListenerConnector<javax.jms.Message> getListenerPortConnector()

Specified by:

getListenerPortConnector in interface IPortConnectedListener<javax.jms.Message>

isThreadCountReadable

public boolean isThreadCountReadable()

Specified by:

isThreadCountReadable in interface IThreadCountControllable

isThreadCountControllable

public boolean isThreadCountControllable()

Specified by:

isThreadCountControllable in interface IThreadCountControllable

getCurrentThreadCount

public int getCurrentThreadCount()

Specified by:

getCurrentThreadCount in interface IThreadCountControllable

getMaxThreadCount

public int getMaxThreadCount()

Specified by:

getMaxThreadCount in interface IThreadCountControllable

increaseThreadCount

public void increaseThreadCount()

Specified by:

increaseThreadCount in interface IThreadCountControllable

decreaseThreadCount

public void decreaseThreadCount()

Specified by:

decreaseThreadCount in interface IThreadCountControllable

getDeliveryCount

public int getDeliveryCount(javax.jms.Message rawMessage)

Specified by:

getDeliveryCount in interface IKnowsDeliveryCount<javax.jms.Message>

setDestinationName

@Mandatory
public void setDestinationName(String destinationName)

Description copied from class: JMSFacade

Name of the JMS destination (queue or topic) to use

Overrides:

setDestinationName in class JMSFacade

setCacheMode

public void setCacheMode(IListenerConnector.CacheMode cacheMode)

setPollGuardInterval

public void setPollGuardInterval(long pollGuardInterval)

Interval in milliseconds for the poll guard to check whether a successful poll was done by the receive (https://docs.oracle.com/javaee/7/api/javax/jms/messageconsumer.html#receive-long-) since last check. If polling has stopped this will be logged and the listener will be stopped and started in an attempt to workaround problems with polling. Polling might stop due to bugs in the JMS driver/implementation which should be fixed by the supplier. As the poll time includes reading and processing of the message no successful poll might be registered since the last check when message processing takes a long time, hence while messages are being processed the check on last successful poll will be skipped. Set to -1 to disable.

Default value

ten times the specified timeout