nl.nn.adapterframework.extensions.ifsa.jms

Class PushingIfsaProviderListener

java.lang.Object

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

nl.nn.adapterframework.extensions.ifsa.jms.PushingIfsaProviderListener

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IKnowsDeliveryCount, IListener<com.ing.ifsa.IFSAMessage>, INamedObject, IPortConnectedListener<com.ing.ifsa.IFSAMessage>, IPushingListener<com.ing.ifsa.IFSAMessage>, IScopeProvider, IThreadCountControllable, ITransactionRequirements, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

IfsaProviderListener, IfsaProviderListener

public class PushingIfsaProviderListener
extends IfsaFacade
implements IPortConnectedListener<com.ing.ifsa.IFSAMessage>, IThreadCountControllable, IKnowsDeliveryCount, ITransactionRequirements

Implementation of IPortConnectedListener 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
• ifsaBifName
• ifsaBtcData

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

For Fire&Forget providers, the message log might get cluttered with messages like:

   [1-10-08 17:10:34:382 CEST] 209d4317 ConnectionMan W J2CA0075W: An active transaction should be present while processing method allocateMCWrapper.
   [1-10-08 17:10:34:382 CEST] 209d4317 ConnectionMan W J2CA0075W: An active transaction should be present while processing method initializeForUOW
 

This is due to a IFSA requirement, that sessions be created using a parameter transacted=true, indicating JMS transacted sessions.

Since:

4.2

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
static String	THREAD_CONTEXT_BIFNAME_KEY
static String	THREAD_CONTEXT_ORIGINAL_RAW_MESSAGE_KEY

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

log

Constructor Summary

Constructors

Constructor and Description
PushingIfsaProviderListener()

Method Summary

Modifier and Type	Method and Description
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() Close all resources used for listening.
void	configure() Checks if messageProtocol and serviceId (only for Requestors) are specified
void	decreaseThreadCount()
Message	extractMessage(com.ing.ifsa.IFSAMessage rawMessage, Map<String,Object> threadContext) Extracts message string from raw message.
int	getCurrentThreadCount()
int	getDeliveryCount(Object rawMessage)
String	getIdFromRawMessage(com.ing.ifsa.IFSAMessage rawMessage, Map<String,Object> threadContext) Extracts ID-string from message obtained from raw message}.
protected String	getIdFromWrapper(IMessageWrapper wrapper, Map<String,Object> threadContext)
IListenerConnector	getListenerPortConnector()
int	getMaxThreadCount()
protected Message	getMessageFromWrapper(IMessageWrapper wrapper, Map<String,Object> threadContext)
void	increaseThreadCount()
boolean	isThreadCountControllable()
boolean	isThreadCountReadable()
void	open() Prepares the listener for receiving messages.
void	setCacheMode(IListenerConnector.CacheMode cacheMode) Controls caching of JMS objects.
void	setListenerPort(String listenerPort) Name of the WebSphere listener port that this JMS Listener binds to.
boolean	transactionalAllowed()
boolean	transactionalRequired()

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

Field Detail

THREAD_CONTEXT_ORIGINAL_RAW_MESSAGE_KEY

public static final String THREAD_CONTEXT_ORIGINAL_RAW_MESSAGE_KEY

See Also:

Constant Field Values

THREAD_CONTEXT_BIFNAME_KEY

public static final String THREAD_CONTEXT_BIFNAME_KEY

See Also:

Constant Field Values

Constructor Detail

PushingIfsaProviderListener

public PushingIfsaProviderListener()

Method Detail

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<com.ing.ifsa.IFSAMessage>

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<com.ing.ifsa.IFSAMessage>

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<com.ing.ifsa.IFSAMessage>

Throws:

ListenerException

transactionalRequired

public boolean transactionalRequired()

Specified by:

transactionalRequired in interface ITransactionRequirements

transactionalAllowed

public boolean transactionalAllowed()

Specified by:

transactionalAllowed in interface ITransactionRequirements

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<com.ing.ifsa.IFSAMessage>

Throws:

ListenerException

getIdFromWrapper

protected String getIdFromWrapper(IMessageWrapper wrapper,
                                  Map<String,Object> threadContext)

getMessageFromWrapper

protected Message getMessageFromWrapper(IMessageWrapper wrapper,
                                        Map<String,Object> threadContext)

getIdFromRawMessage

public String getIdFromRawMessage(com.ing.ifsa.IFSAMessage rawMessage,
                                  Map<String,Object> threadContext)
                           throws ListenerException

Extracts ID-string from message obtained from raw message}. Puts also the following parameters in the threadContext:

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

Specified by:

getIdFromRawMessage in interface IListener<com.ing.ifsa.IFSAMessage>

Returns:

ID-string of message for adapter.

Throws:

ListenerException

extractMessage

public Message extractMessage(com.ing.ifsa.IFSAMessage rawMessage,
                              Map<String,Object> threadContext)
                       throws ListenerException

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

Specified by:

extractMessage in interface IListener<com.ing.ifsa.IFSAMessage>

Returns:

input message for adapter.

Throws:

ListenerException

getListenerPortConnector

public IListenerConnector getListenerPortConnector()

Specified by:

getListenerPortConnector in interface IPortConnectedListener<com.ing.ifsa.IFSAMessage>

setListenerPort

public void setListenerPort(String listenerPort)

Name of the WebSphere listener port that this JMS Listener binds to. Optional. This property is only used in EJB Deployment mode and has no effect otherwise. If it is not set in EJB Deployment Mode, then the listener port name is constructed by the EjbListenerPortConnector from the Listener name, Adapter name and the Receiver name.

Parameters:

listenerPort - Name of the listener port, as configured in the application server.

setCacheMode

public void setCacheMode(IListenerConnector.CacheMode cacheMode)

Controls caching of JMS objects. Must be one of CACHE_NONE, CACHE_CONNECTION, CACHE_SESSION, CACHE_CONSUMER

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(Object rawMessage)

Specified by:

getDeliveryCount in interface IKnowsDeliveryCount