nl.nn.adapterframework.extensions.esb

Class EsbJmsListener

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jms.JMSFacade

nl.nn.adapterframework.jms.JmsListenerBase

nl.nn.adapterframework.jms.PushingJmsListener

nl.nn.adapterframework.jms.JmsListener

nl.nn.adapterframework.extensions.esb.EsbJmsListener

All Implemented Interfaces:

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

Direct Known Subclasses:

FxfListener

@Category(value="NN-Special")
public class EsbJmsListener
extends JmsListener
implements ITransactionRequirements

ESB (Enterprise Service Bus) extension of JmsListener.

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EsbJmsListener.MessageProtocol

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

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	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
protected Map<String,Object>	getMessageProperties(Map<String,Object> threadContext) Set additional message headers/properties on the JMS response, read after message has been processed!
protected String	getResultFromxPath(String message, String xPathExpression)
protected Map<String,String>	getxPathLogMap()
boolean	isSynchronous()
protected String	retrieveIdFromMessage(javax.jms.Message message, Map<String,Object> threadContext)
void	setCopyAEProperties(boolean b) if true, all JMS properties in the request starting with "ae_" are copied to the reply.
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	setMessageProtocol(EsbJmsListener.MessageProtocol string) protocol of ESB service to be called
void	setUseReplyTo(boolean newUseReplyTo)
void	setxPathLoggingKeys(String string) Comma separated list of all XPath keys that need to be logged.
boolean	transactionalAllowed()
boolean	transactionalRequired()

Methods inherited from class nl.nn.adapterframework.jms.PushingJmsListener

close, decreaseThreadCount, getCurrentThreadCount, getDeliveryCount, getListenerPortConnector, getMaxThreadCount, increaseThreadCount, isThreadCountControllable, isThreadCountReadable, open, setCacheMode, setDestinationName, setPollGuardInterval

Methods inherited from class nl.nn.adapterframework.jms.JmsListenerBase

addParameter, extractMessage, getIdFromRawMessage, getParameterList, messageWillBeRedeliveredOnExitStateError, prepareReply, prepareReply, sendReply, setReplyDeliveryMode, setReplyDestinationName, setReplyEncodingStyleURI, setReplyMessageTimeToLive, setReplyMessageType, setReplyNamespaceURI, setReplyPriority, setReplySoapAction, setSender, setSoap, setSoapHeaderSessionKey, setTimeout, setTimeOut

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

extractMessage, getIdFromRawMessage

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

getSender

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

getDomain

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

isTransacted

Constructor Detail

EsbJmsListener

public EsbJmsListener()

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 PushingJmsListener

Throws:

ConfigurationException

getxPathLogMap

protected Map<String,String> getxPathLogMap()

retrieveIdFromMessage

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

Overrides:

retrieveIdFromMessage in class JmsListenerBase

Throws:

ListenerException

getResultFromxPath

protected String getResultFromxPath(String message,
                                    String xPathExpression)

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>

Overrides:

afterMessageProcessed in class JmsListenerBase

Throws:

ListenerException

getMessageProperties

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

Description copied from class: JmsListenerBase

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

Overrides:

getMessageProperties in class JmsListenerBase

Parameters:

threadContext - which has been build during the pipeline

Returns:

a map with headers to set to the JMS response

setMessageProtocol

@Mandatory
public void setMessageProtocol(EsbJmsListener.MessageProtocol string)

protocol of ESB service to be called

isSynchronous

public boolean isSynchronous()

transactionalRequired

public boolean transactionalRequired()

Specified by:

transactionalRequired in interface ITransactionRequirements

transactionalAllowed

public boolean transactionalAllowed()

Specified by:

transactionalAllowed in interface ITransactionRequirements

setCopyAEProperties

public void setCopyAEProperties(boolean b)

if true, all JMS properties in the request starting with "ae_" are copied to the reply.

Default value

false

setForceMessageIdAsCorrelationId

@Default(value="if messageProtocol=<code>RR</code>: </td><td><code>true</code>")
public void setForceMessageIdAsCorrelationId(boolean force)

Description copied from class: JmsListenerBase

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.

Overrides:

setForceMessageIdAsCorrelationId in class JmsListenerBase

setUseReplyTo

@Default(value="if messageProtocol=<code>FF</code>: <code>false</code>")
public void setUseReplyTo(boolean newUseReplyTo)

Overrides:

setUseReplyTo in class JmsListenerBase

setxPathLoggingKeys

public void setxPathLoggingKeys(String string)

Comma separated list of all XPath keys that need to be logged. (overrides msg.log.keys property)