Class PushingJmsListener

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.AbstractJmsListener

org.frankframework.jms.PushingJmsListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, HasSender, IConfigurable, IKnowsDeliveryCount<jakarta.jms.Message>, IListener<jakarta.jms.Message>, IPortConnectedListener<jakarta.jms.Message>, IPushingListener<jakarta.jms.Message>, IRedeliveringListener<jakarta.jms.Message>, IScopeProvider, IThreadCountControllable, IWithParameters, IXAEnabled, NameAware, ConfigurableLifecycle, ReceiverAware<jakarta.jms.Message>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

Direct Known Subclasses:

JmsListener

public class PushingJmsListener
extends AbstractJmsListener
implements IPortConnectedListener<jakarta.jms.Message>, IThreadCountControllable, IKnowsDeliveryCount<jakarta.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.

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.

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 TextMessages and BytesMessage

Since:

4.8

Author:

Tim van der Leeuw

Nested Class Summary

Nested classes/interfaces inherited from class JMSFacade

JMSFacade.AcknowledgeMode, JMSFacade.DeliveryMode, JMSFacade.JmsDestinationType, JMSFacade.MessageClass, JMSFacade.SubscriberType

Field Summary

Fields inherited from class JMSFacade

JMS_MESSAGECLASS_KEY, log, messagingSource

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
PushingJmsListener()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
void	decreaseThreadCount()
int	getCurrentThreadCount()
int	getDeliveryCount(@NonNull RawMessageWrapper<jakarta.jms.Message> rawMessage)
int	getMaxThreadCount()
void	increaseThreadCount()
boolean	isThreadCountControllable()
boolean	isThreadCountReadable()
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 (JMS Receive call) since last check.
void	start()	Obtains a connection and a serviceQueue.
void	stop()	Releases references to serviceQueue and connection.
RawMessageWrapper<jakarta.jms.Message>	wrapRawMessage(jakarta.jms.Message rawMessage, PipeLineSession session)	Wrap a raw message in a MessageWrapper.

Methods inherited from class AbstractJmsListener

addParameter, afterMessageProcessed, extractMessage, extractMessageProperties, getMessageProperties, getParameterList, messageWillBeRedeliveredOnExitStateError, prepareReply, prepareReply, sendReply, setForceMessageIdAsCorrelationId, setReplyDeliveryMode, setReplyDestinationName, setReplyEncodingStyleURI, setReplyMessageTimeToLive, setReplyMessageType, setReplyNamespaceURI, setReplyPriority, setReplySoapAction, setSender, setSoap, setSoapHeaderSessionKey, setTimeout, setUseReplyTo

Methods inherited from class JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, createMessage, createMessage, createSession, createTextMessage, extractMessage, extractMessageBody, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessagingSource, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isRunning, isSessionsArePooled, logMessageDetails, send, send, send, send, send, sendByQueue, sendByTopic, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationType, setJndiContextPrefix, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setName, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, toString

Methods inherited from class JndiBase

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

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasSender

getSender

Methods inherited from interface IListener

afterMessageProcessed, extractMessage

Methods inherited from interface IPortConnectedListener

checkTransactionManagerValidity, getExceptionListener, getHandler

Methods inherited from interface IPushingListener

setExceptionListener, setHandler

Methods inherited from interface IRedeliveringListener

messageWillBeRedeliveredOnExitStateError

Methods inherited from interface IXAEnabled

isTransacted

Methods inherited from interface NameAware

setName

Methods inherited from interface ReceiverAware

getReceiver, setReceiver

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Constructor Details

PushingJmsListener

public PushingJmsListener()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractJmsListener

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from class: JMSFacade

Obtains a connection and a serviceQueue.

Specified by:

start in interface ConfigurableLifecycle

Specified by:

start in interface IListener<jakarta.jms.Message>

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractJmsListener

stop

public void stop()

Description copied from class: JMSFacade

Releases references to serviceQueue and connection.

Specified by:

stop in interface IListener<jakarta.jms.Message>

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractJmsListener

wrapRawMessage

public RawMessageWrapper<jakarta.jms.Message> wrapRawMessage(jakarta.jms.Message rawMessage,
 PipeLineSession session)

Description copied from interface: IPushingListener

Wrap a raw message in a MessageWrapper. Populate PipeLineSession with properties from the message.

If the returned object is an instance of MessageWrapper then the Receiver.processRawMessage(IListener, RawMessageWrapper, PipeLineSession, boolean) will not call IListener.extractMessage(RawMessageWrapper, Map) but directly access the enclosed Message and the

invalid reference

RawMessageWrapper#getContext()

.

Specified by:

wrapRawMessage in interface IPushingListener<jakarta.jms.Message>

Parameters:

rawMessage - The raw message data, unwrapped

session - PipeLineSession to populate with properties from the message.

Returns:

Wrapped raw 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(@NonNull RawMessageWrapper<jakarta.jms.Message> rawMessage)

Specified by:

getDeliveryCount in interface IKnowsDeliveryCount<jakarta.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 (JMS Receive call) 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