Class MessageQueueListener

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.AbstractJmsListener

org.frankframework.jms.PullingJmsListener

org.frankframework.jms.MessageQueueListener

All Implemented Interfaces:

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

public class MessageQueueListener
extends PullingJmsListener

Listener that receives messages from a MessageQueueSender in another Adapter. Any PipeLineSession keys sent by the source adapter will be in the receiving PipeLineSession. This listener is the JMS-based equivalent of the MessageStoreListener.

If the message received is not in the expected format produced by the MessageQueueSender, the listener will still do its best to convert it to a regular input-message, so it can also be used with a regular JmsSender, or other JMS sources.

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

Method Summary

Modifier and Type	Method	Description
Message	extractMessage(@NonNull RawMessageWrapper<jakarta.jms.Message> rawMessage, @NonNull Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map).
void	setMessageClass(JMSFacade.MessageClass messageClass)	The JMS Message class for the outgoing message.

Methods inherited from class PullingJmsListener

afterMessageProcessed, canGoOn, closeThread, getRawMessage, getRawMessage, getReceiver, getSession, openThread, releaseReceiver, releaseSession, sendReply, setRunStateEnquirer

Methods inherited from class AbstractJmsListener

addParameter, configure, extractMessageProperties, getMessageProperties, getParameterList, messageWillBeRedeliveredOnExitStateError, prepareReply, prepareReply, setForceMessageIdAsCorrelationId, setReplyDeliveryMode, setReplyDestinationName, setReplyEncodingStyleURI, setReplyMessageTimeToLive, setReplyMessageType, setReplyNamespaceURI, setReplyPriority, setReplySoapAction, setSender, setSoap, setSoapHeaderSessionKey, setTimeout, setUseReplyTo, start, stop

Methods inherited from class JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, 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, setDestinationName, setDestinationType, setJndiContextPrefix, setLookupDestination, 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 IConfigurable

configure

Methods inherited from interface IListener

start, stop

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

MessageQueueListener

public MessageQueueListener()

Method Details

extractMessage

public Message extractMessage(@NonNull RawMessageWrapper<jakarta.jms.Message> rawMessage,
 @NonNull Map<String,Object> context)
                       throws ListenerException

Description copied from class: AbstractJmsListener

Extracts data from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the context.

Specified by:

extractMessage in interface IListener<jakarta.jms.Message>

Overrides:

extractMessage in class AbstractJmsListener

Parameters:

rawMessage - The RawMessageWrapper from which to extract the Message.

context - Context to populate. Either a PipeLineSession or a threadContext depending on caller.

Returns:

String input Message for adapter.

Throws:

ListenerException

setMessageClass

@Protected
public void setMessageClass(JMSFacade.MessageClass messageClass)

Description copied from class: JMSFacade

The JMS Message class for the outgoing message. Currently supported are JMSFacade.MessageClass.TEXT for JMS TextMessage, JMSFacade.MessageClass.BYTES for JMS BytesMessage, or JMSFacade.MessageClass.AUTO for auto-determination based on whether the input Message is binary or character.

Defaults to JMSFacade.MessageClass.AUTO, unless the default is overridden in AppConstants with property jms.messageClass.default

Overrides:

setMessageClass in class JMSFacade