nl.nn.adapterframework.jms

Class JmsListenerBase

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jms.JMSFacade

nl.nn.adapterframework.jms.JmsListenerBase

All Implemented Interfaces:

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

Direct Known Subclasses:

PullingJmsListener, PushingJmsListener

public class JmsListenerBase
extends JMSFacade
implements HasSender, IWithParameters, IRedeliveringListener<javax.jms.Message>

Common baseclass for Pulling and Pushing JMS Listeners.

Since:

4.9

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

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter p)
void	afterMessageProcessed(PipeLineResult plr, Object rawMessageOrWrapper, Map<String,Object> threadContext) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
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.
Message	extractMessage(javax.jms.Message rawMessage, Map<String,Object> threadContext) Extracts string from message obtained from getRawMessage.
String	getIdFromRawMessage(javax.jms.Message rawMessage, Map<String,Object> threadContext) Fill in thread-context with things needed by the JMSListener code.
protected Map<String,Object>	getMessageProperties(Map<String,Object> threadContext) Set additional message headers/properties on the JMS response, read after message has been processed!
ParameterList	getParameterList() return the Parameters
boolean	messageWillBeRedeliveredOnExitStateError(Map<String,Object> context)
void	open() Obtains a connection and a serviceQueue.
Message	prepareReply(Message rawReply, Map<String,Object> threadContext)
Message	prepareReply(Message rawReply, Map<String,Object> threadContext, String soapHeader)
protected String	retrieveIdFromMessage(javax.jms.Message message, Map<String,Object> threadContext)
protected void	sendReply(PipeLineResult plr, javax.jms.Destination replyTo, String replyCid, long timeToLive, boolean ignoreInvalidDestinationException, Map<String,Object> threadContext, Map<String,Object> properties)
void	setForceMessageIdAsCorrelationId(boolean force) By default, the JmsListener takes the Correlation-ID (if present) as the ID that has to be used as Correlation-ID of the reply.
void	setReplyDeliveryMode(JMSFacade.DeliveryMode replyDeliveryMode) Controls mode that reply messages are sent with
void	setReplyDestinationName(String destinationName) Name of the JMS destination (queue or topic) to use for sending replies.
void	setReplyEncodingStyleURI(String string)
void	setReplyMessageTimeToLive(long l) Time in milliseconds after which the reply-message will expire
void	setReplyMessageType(String string) Value of the JMSType field of the reply message
void	setReplyNamespaceURI(String string)
void	setReplyPriority(int i) Sets the priority that is used to deliver the reply message.
void	setReplySoapAction(String string)
void	setSender(ISender newSender) Deprecated.
void	setSoap(boolean b) If true, messages sent are put in a SOAP envelope
void	setSoapHeaderSessionKey(String string) sessionKey to store the SOAP header of the incoming message
void	setTimeout(long newTimeOut) Receive timeout in milliseconds as specified by the JMS API, see https://docs.oracle.com/javaee/7/api/javax/jms/MessageConsumer.html#receive-long-
void	setTimeOut(long newTimeOut) Deprecated.
void	setUseReplyTo(boolean newUseReplyTo)

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, 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.HasSender

getSender

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

getDomain

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

isTransacted

Constructor Detail

JmsListenerBase

public JmsListenerBase()

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 JndiBase

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 JMSFacade

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 JMSFacade

getIdFromRawMessage

public String getIdFromRawMessage(javax.jms.Message rawMessage,
                                  Map<String,Object> threadContext)
                           throws ListenerException

Fill in thread-context with things needed by the JMSListener code. This includes a Session. The Session object can be passed in externally.

Specified by:

getIdFromRawMessage in interface IListener<javax.jms.Message>

Parameters:

rawMessage - - Original message received, can not be null

threadContext - - Thread context to be populated, can not be null

Returns:

Correlation ID string.

Throws:

ListenerException

retrieveIdFromMessage

protected String retrieveIdFromMessage(javax.jms.Message message,
                                       Map<String,Object> threadContext)
                                throws ListenerException

Throws:

ListenerException

extractMessage

public Message extractMessage(javax.jms.Message rawMessage,
                              Map<String,Object> threadContext)
                       throws ListenerException

Extracts string from message obtained from getRawMessage. May also extract other parameters from the message and put those in the threadContext.

Specified by:

extractMessage in interface IListener<javax.jms.Message>

Returns:

String input message for adapter.

Throws:

ListenerException

prepareReply

public Message prepareReply(Message rawReply,
                            Map<String,Object> threadContext)
                     throws ListenerException

Throws:

ListenerException

prepareReply

public Message prepareReply(Message rawReply,
                            Map<String,Object> threadContext,
                            String soapHeader)
                     throws ListenerException

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult plr,
                                  Object rawMessageOrWrapper,
                                  Map<String,Object> threadContext)
                           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>

Throws:

ListenerException

messageWillBeRedeliveredOnExitStateError

public boolean messageWillBeRedeliveredOnExitStateError(Map<String,Object> context)

Specified by:

messageWillBeRedeliveredOnExitStateError in interface IRedeliveringListener<javax.jms.Message>

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

Throws:

SenderException

ListenerException

NamingException

javax.jms.JMSException

IOException

setSender

@Deprecated
public void setSender(ISender newSender)

Deprecated.

getMessageProperties

protected Map<String,Object> getMessageProperties(Map<String,Object> threadContext)

Set additional message headers/properties on the JMS response, read after message has been processed!

Parameters:

threadContext - which has been build during the pipeline

Returns:

a map with headers to set to the JMS response

addParameter

public void addParameter(Parameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public ParameterList getParameterList()

return the Parameters

Specified by:

getParameterList in interface IWithParameters

setForceMessageIdAsCorrelationId

public void setForceMessageIdAsCorrelationId(boolean force)

By default, the JmsListener takes the Correlation-ID (if present) as the ID that has to be used as Correlation-ID of the reply. When set to true, the messageID is used as Correlation-ID of the reply.

Default value

false

setTimeOut

@Deprecated
public void setTimeOut(long newTimeOut)

Deprecated.

setTimeout

public void setTimeout(long newTimeOut)

Receive timeout in milliseconds as specified by the JMS API, see https://docs.oracle.com/javaee/7/api/javax/jms/MessageConsumer.html#receive-long-

Default value

1000

setUseReplyTo

public void setUseReplyTo(boolean newUseReplyTo)

Default value

true

setReplyDestinationName

public void setReplyDestinationName(String destinationName)

Name of the JMS destination (queue or topic) to use for sending replies. If useReplyTo=true, the sender specified reply destination takes precedence over this one.

setReplyMessageType

public void setReplyMessageType(String string)

Value of the JMSType field of the reply message

Default value

not set by application

setReplyDeliveryMode

public void setReplyDeliveryMode(JMSFacade.DeliveryMode replyDeliveryMode)

Controls mode that reply messages are sent with

Default value

NON_PERSISTENT

setReplyPriority

public void setReplyPriority(int i)

Sets the priority that is used to deliver the reply message. Ranges from 0 to 9. Effectively the default priority is set by JMS to 4, -1 means not set and thus uses the JMS default

Default value

-1

setReplyMessageTimeToLive

public void setReplyMessageTimeToLive(long l)

Time in milliseconds after which the reply-message will expire

Default value

0

setSoap

public void setSoap(boolean b)

If true, messages sent are put in a SOAP envelope

Default value

false

setReplyEncodingStyleURI

public void setReplyEncodingStyleURI(String string)

setReplyNamespaceURI

public void setReplyNamespaceURI(String string)

setReplySoapAction

public void setReplySoapAction(String string)

setSoapHeaderSessionKey

public void setSoapHeaderSessionKey(String string)

sessionKey to store the SOAP header of the incoming message

Default value

soapHeader