nl.nn.adapterframework.extensions.ifsa.jms

Class PullingIfsaProviderListener

java.lang.Object

nl.nn.adapterframework.extensions.ifsa.jms.IfsaFacade

nl.nn.adapterframework.extensions.ifsa.jms.PullingIfsaProviderListener

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IListener, INamedObject, IPullingListener, IScopeProvider, RunStateEnquiring, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class PullingIfsaProviderListener
extends IfsaFacade
implements IPullingListener, INamedObject, RunStateEnquiring

Implementation of IPullingListener that acts as an IFSA-service. There is no need or possibility to set the ServiceId as the Provider will receive all messages for this Application on the same serviceQueue. The following session keys are set for each message:

• id (the message id)
• cid (the correlation id)
• timestamp
• replyTo
• messageText
• fullIfsaServiceName
• ifsaServiceName
• ifsaGroup
• ifsaOccurrence
• ifsaVersion

N.B. Starting from IFSA-jms version 2.2.10.055(beta) a feature was created to have separate service-queues for Request/Reply and for Fire & Forget services. This allows applications to provide both types of services, each in its own transaction mode. This options is not compatible with earlier versions of IFSA-jms. If an earlier version of IFSA-jms is deployed on the server, this behaviour must be disabled by the following setting in DeploymentSpecifics.properties: ifsa.provider.useSelectors=false

Since:

4.2

Author:

Gerrit van Brakel

Field Summary

Fields inherited from class nl.nn.adapterframework.extensions.ifsa.jms.IfsaFacade

log

Constructor Summary

Constructors

Constructor and Description
PullingIfsaProviderListener()

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult plr, Object rawMessage, Map threadContext) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
protected boolean	canGoOn()
void	close() Close all resources used for listening.
void	closeThread(Map threadContext) Finalizes a message receiving thread.
void	configure() Checks if messageProtocol and serviceId (only for Requestors) are specified
Message	extractMessage(Object rawMessage, Map threadContext) Extracts string from message obtained from getRawMessage(Map).
String	getIdFromRawMessage(Object rawMessage, Map threadContext) Extracts ID-string from message obtained from getRawMessage(Map).
protected String	getIdFromWrapper(IMessageWrapper wrapper, Map threadContext)
protected Message	getMessageFromWrapper(IMessageWrapper wrapper, Map threadContext)
Object	getRawMessage(Map threadContext) Retrieves messages to be processed by the server, implementing an IFSA-service, but does no processing on it.
protected javax.jms.QueueReceiver	getReceiver(Map threadContext, javax.jms.QueueSession session)
protected javax.jms.QueueSession	getSession(Map threadContext)
void	open() Prepares the listener for receiving messages.
Map	openThread() Prepares a thread for receiving messages.
protected void	releaseReceiver(javax.jms.QueueReceiver receiver)
protected void	releaseSession(javax.jms.Session session)
void	SetRunStateEnquirer(RunStateEnquirer enquirer)

Methods inherited from class nl.nn.adapterframework.extensions.ifsa.jms.IfsaFacade

cleanUpAfterException, closeReplyReceiver, closeService, closeSession, createSender, createSession, getAckMode, getApplicationId, getExpiry, getExpiry, getLogPrefix, getMessageProtocol, getMessageProtocolEnum, getMessagingSource, getName, getPhysicalDestinationName, getProviderSelector, getReplyReceiver, getServiceId, getServiceQueue, getServiceReceiver, getTimeOut, isJmsTransacted, isProvider, isRequestor, isSessionsArePooled, openService, sendMessage, sendReply, setAckMode, setAcknowledgeMode, setApplicationId, setMessageProtocol, setName, setServiceId, setTimeOut, toString, useSelectorsForProviders

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

Constructor Detail

PullingIfsaProviderListener

public PullingIfsaProviderListener()

Method Detail

getSession

protected javax.jms.QueueSession getSession(Map threadContext)
                                     throws ListenerException

Throws:

ListenerException

releaseSession

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

Throws:

ListenerException

getReceiver

protected javax.jms.QueueReceiver getReceiver(Map threadContext,
                                              javax.jms.QueueSession session)
                                       throws ListenerException

Throws:

ListenerException

releaseReceiver

protected void releaseReceiver(javax.jms.QueueReceiver receiver)
                        throws ListenerException

Throws:

ListenerException

configure

public void configure()
               throws ConfigurationException

Description copied from class: IfsaFacade

Checks if messageProtocol and serviceId (only for Requestors) are specified

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener

Overrides:

configure in class IfsaFacade

Throws:

ConfigurationException

open

public void open()
          throws ListenerException

Description copied from interface: IListener

Prepares the listener for receiving messages. open() is called once each time the listener is started.

Specified by:

open in interface IListener

Throws:

ListenerException

openThread

public Map 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

Returns:

the threadContext for this thread. The threadContext is a Map in which thread-specific data can be stored.

Throws:

ListenerException

close

public void close()
           throws ListenerException

Description copied from interface: IListener

Close all resources used for listening. Called once once each time the listener is stopped.

Specified by:

close in interface IListener

Throws:

ListenerException

closeThread

public void closeThread(Map 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

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult plr,
                                  Object rawMessage,
                                  Map 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

Throws:

ListenerException

getIdFromWrapper

protected String getIdFromWrapper(IMessageWrapper wrapper,
                                  Map threadContext)

getMessageFromWrapper

protected Message getMessageFromWrapper(IMessageWrapper wrapper,
                                        Map threadContext)

getIdFromRawMessage

public String getIdFromRawMessage(Object rawMessage,
                                  Map threadContext)
                           throws ListenerException

Extracts ID-string from message obtained from getRawMessage(Map). Puts also the following parameters in the threadContext:

• id
• cid
• timestamp
• replyTo
• messageText
• fullIfsaServiceName
• ifsaServiceName
• ifsaGroup
• ifsaOccurrence
• ifsaVersion

Specified by:

getIdFromRawMessage in interface IListener

Returns:

ID-string of message for adapter.

Throws:

ListenerException

getRawMessage

public Object getRawMessage(Map threadContext)
                     throws ListenerException

Retrieves messages to be processed by the server, implementing an IFSA-service, but does no processing on it.

Specified by:

getRawMessage in interface IPullingListener

Throws:

ListenerException

extractMessage

public Message extractMessage(Object rawMessage,
                              Map threadContext)
                       throws ListenerException

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

Specified by:

extractMessage in interface IListener

Returns:

input message for adapter.

Throws:

ListenerException

canGoOn

protected boolean canGoOn()

SetRunStateEnquirer

public void SetRunStateEnquirer(RunStateEnquirer enquirer)

Specified by:

SetRunStateEnquirer in interface RunStateEnquiring