nl.nn.adapterframework.extensions.bis

Class BisJmsListener

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

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, IWithParameters, IXAEnabled, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Deprecated.

Please use JmsListener combined with BisWrapperPipe

@Deprecated
 @ConfigurationWarning(value="Please change to JmsListener combined with BisWrapperPipe")
public class BisJmsListener
extends JmsListener

Bis (Business Integration Services) extension of JmsListener.
Example request:

        <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
                <soap:Header>
                        <bis:MessageHeader xmlns:bis="http://www.ing.com/CSP/XSD/General/Message_2">
                                <bis:From>
                                        <bis:Id>PolicyConversion_01_ServiceAgents_01</bis:Id>
                                </bis:From>
                                <bis:HeaderFields>
                                        <bis:ConversationId>1790257_10000050_04</bis:ConversationId>
                                        <bis:MessageId>1790257</bis:MessageId>
                                        <bis:Timestamp>2011-03-02T10:26:31.464+01:00</bis:Timestamp>
                                </bis:HeaderFields>
                        </bis:MessageHeader>
                </soap:Header>
                <soap:Body>
                        <pcr:GetRequest xmlns:pcr="http://www.ing.com/nl/pcretail/ts/migrationauditdata_01">
                                <pcr:PolicyDetails>
                                        <pcr:RVS_PARTY_ID>1790257</pcr:RVS_PARTY_ID>
                                        <pcr:RVS_POLICY_NUMBER>10000050</pcr:RVS_POLICY_NUMBER>
                                        <pcr:RVS_BRANCH_CODE>04</pcr:RVS_BRANCH_CODE>
                                </pcr:PolicyDetails>
                        </pcr:GetRequest>
                </soap:Body>
        </soap:Envelope>
 

The element MessageHeader in the soap header is mandatory.
Example reply:

        <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
                <soap:Header>
                        <bis:MessageHeader xmlns:bis="http://www.ing.com/CSP/XSD/General/Message_2">
                                <bis:From>
                                        <bis:Id>IJA_DB4CONV</bis:Id>
                                </bis:From>
                                <bis:HeaderFields>
                                        <bis:ConversationId>1790257_10000050_04</bis:ConversationId>
                                        <bis:MessageId>rn09ce_0a3b8d2d--33192359_12e588118c1_-612f</bis:MessageId>
                                        <bis:ExternalRefToMessageId>1790257</bis:ExternalRefToMessageId>
                                        <bis:Timestamp>2011-03-02T10:26:31</bis:Timestamp>
                                </bis:HeaderFields>
                        </bis:MessageHeader>
                </soap:Header>
                <soap:Body>
                        <GetResponse xmlns="http://www.ing.com/nl/pcretail/ts/migrationcasedata_01">
                                <CaseData>...</CaseData>
                                <bis:Result xmlns:bis="http://www.ing.com/CSP/XSD/General/Message_2">
                                        <bis:Status>OK</bis:Status>
                                </bis:Result>
                        </GetResponse>
                </soap:Body>
        </soap:Envelope>
 

The elements MessageHeader in the soap header and Result in the soap body are mandatory.
Example element Result in case of an error reply:

        <bis:Result xmlns:bis="http://www.ing.com/CSP/XSD/General/Message_2">
                <bis:Status>ERROR</bis:Status>
                <bis:ErrorList>
                        <bis:Error>
                                <bis:Code>ERR6003</bis:Code>
                                <bis:Reason>Invalid Request Message</bis:Reason>
                                <bis:Service>
                                        <bis:Name>migrationauditdata_01</bis:Name>
                                        <bis:Context>1</bis:Context>
                                        <bis:Action>
                                                <bis:Name>SetPolicyDetails_Action</bis:Name>
                                                <bis:Version>1</bis:Version>
                                        </bis:Action>
                                </bis:Service>
                                <bis:DetailList>
                                        <bis:Detail>
                                                <bis:Code/>
                                                <bis:Text>Pipe [Validate tibco request] msgId [Test Tool correlation id] got invalid xml according to schema [....</bis:Text>
                                        </bis:Detail>
                                </bis:DetailList>
                        </bis:Error>
                </bis:ErrorList>
        </bis:Result>
 

Configuration:

Author:

Peter Leeuwenburgh

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

attributes	description	default
className	nl.nn.adapterframework.extensions.bis.BisSoapJmsListener
soap	when true, messages sent are put in a SOAP envelope	true
requestXPath	xpath expression to extract the message which is passed to the pipeline. When soap=true the initial message is the content of the soap body. If empty, the content of the soap body is passed (without the root body)
requestNamespaceDefs	namespace defintions for requestXPath. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions
messageHeaderInSoapBody	when true, the MessageHeader is put in the SOAP body instead of in the SOAP header (first one is the old BIS standard)	false
resultInPayload	when true, the Result is put in the payload (as last child in root tag) instead of in the SOAP body as sibling of the payload (last one is the old BIS standard)	true
omitResult	when true, the Result is omitted and instead of Result/Status 'ERROR' a ListenerException is thrown (this functionality will be used during migration from IFSA to TIBCO)	false
removeRequestNamespaces	when set true namespaces (and prefixes) in the request are removed (this functionality will be used during migration from IFSA to TIBCO)	false
layByNamespace	when true, the namespace of the request is laid by and afterwards added to the reply (this functionality will be used during migration from IFSA to TIBCO)	false
errorCodeSessionKey	key of session variable to store error code in (if an error occurs)	bisErrorCode
errorTextSessionKey	key of session variable to store error text in (if an error occurs). If not specified, the following error text is derived from the error code: errorCode errorText ERR6002 Service Interface Request Time Out ERR6003 Invalid Request Message ERR6004 Invalid Backend system response ERR6005 Backend system failure response ERR6999 Unspecified Errors
errorReasonSessionKey	key of session variable to store error reason in (if an error occurs)	bisErrorReason
serviceName	name of the service; used in the error reply
actionName	name of the operation; used in the error reply

Constructors

Constructor and Description
BisJmsListener() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	configure() Deprecated. configure() is called once at startup of the framework in the configure() method of the owner of this listener.
Message	extractMessageBody(Message message, Map<String,Object> context, SoapWrapper soapWrapper) Deprecated.
String	getActionName() Deprecated.
String	getErrorCodeSessionKey() Deprecated.
String	getErrorReasonSessionKey() Deprecated.
String	getErrorTextSessionKey() Deprecated.
String	getRequestNamespaceDefs() Deprecated.
String	getRequestXPath() Deprecated.
String	getServiceName() Deprecated.
boolean	isLayByNamespace() Deprecated.
boolean	isMessageHeaderInSoapBody() Deprecated.
boolean	isOmitResult() Deprecated.
boolean	isRemoveRequestNamespaces() Deprecated.
boolean	isResultInPayload() Deprecated.
Message	prepareReply(Message rawReply, Map<String,Object> threadContext) Deprecated.
String	prepareResult(String errorCode, Map<String,Object> threadContext) Deprecated.
void	setActionName(String actionName) Deprecated.
void	setErrorCodeSessionKey(String errorCodeSessionKey) Deprecated.
void	setErrorReasonSessionKey(String errorReasonSessionKey) Deprecated.
void	setErrorTextSessionKey(String errorTextSessionKey) Deprecated.
void	setLayByNamespace(boolean b) Deprecated.
void	setMessageHeaderInSoapBody(boolean b) Deprecated.
void	setOmitResult(boolean b) Deprecated.
void	setRemoveRequestNamespaces(boolean b) Deprecated.
void	setRequestNamespaceDefs(String requestNamespaceDefs) Deprecated.
void	setRequestXPath(String requestXPath) Deprecated.
void	setResultInPayload(boolean b) Deprecated.
void	setServiceName(String serviceName) Deprecated.

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

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

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

addParameter, afterMessageProcessed, extractMessage, extractMessageProperties, getMessageProperties, getParameterList, messageWillBeRedeliveredOnExitStateError, prepareReply, sendReply, setForceMessageIdAsCorrelationId, setReplyDeliveryMode, setReplyDestinationName, setReplyEncodingStyleURI, setReplyMessageTimeToLive, setReplyMessageType, setReplyNamespaceURI, setReplyPriority, setReplySoapAction, setSender, setSoap, setSoapHeaderSessionKey, setTimeout, setTimeOut, setUseReplyTo

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

checkTransactionManagerValidity, closeSession, createMessage, createSession, extractMessage, getAcknowledgeModeEnum, getConnectionFactoryInfo, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getManagedConnectionFactory, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessagingSource, getMessagingSourceFactory, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isSessionsArePooled, logMessageDetails, 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

afterMessageProcessed, extractMessage

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

BisJmsListener

public BisJmsListener()

Deprecated.

Method Detail

configure

public void configure()
               throws ConfigurationException

Deprecated.

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

extractMessageBody

public Message extractMessageBody(Message message,
                                  Map<String,Object> context,
                                  SoapWrapper soapWrapper)
                           throws SAXException,
                                  TransformerException,
                                  IOException

Deprecated.

Overrides:

extractMessageBody in class JMSFacade

Throws:

SAXException

TransformerException

IOException

prepareReply

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

Deprecated.

Overrides:

prepareReply in class JmsListenerBase

Throws:

ListenerException

prepareResult

public String prepareResult(String errorCode,
                            Map<String,Object> threadContext)
                     throws DomBuilderException,
                            IOException,
                            TransformerException

Deprecated.

Throws:

DomBuilderException

IOException

TransformerException

setRequestXPath

public void setRequestXPath(String requestXPath)

Deprecated.

getRequestXPath

public String getRequestXPath()

Deprecated.

setRequestNamespaceDefs

public void setRequestNamespaceDefs(String requestNamespaceDefs)

Deprecated.

getRequestNamespaceDefs

public String getRequestNamespaceDefs()

Deprecated.

setMessageHeaderInSoapBody

public void setMessageHeaderInSoapBody(boolean b)

Deprecated.

isMessageHeaderInSoapBody

public boolean isMessageHeaderInSoapBody()

Deprecated.

setResultInPayload

public void setResultInPayload(boolean b)

Deprecated.

isResultInPayload

public boolean isResultInPayload()

Deprecated.

setOmitResult

public void setOmitResult(boolean b)

Deprecated.

isOmitResult

public boolean isOmitResult()

Deprecated.

setRemoveRequestNamespaces

public void setRemoveRequestNamespaces(boolean b)

Deprecated.

isRemoveRequestNamespaces

public boolean isRemoveRequestNamespaces()

Deprecated.

setLayByNamespace

public void setLayByNamespace(boolean b)

Deprecated.

isLayByNamespace

public boolean isLayByNamespace()

Deprecated.

setErrorCodeSessionKey

public void setErrorCodeSessionKey(String errorCodeSessionKey)

Deprecated.

getErrorCodeSessionKey

public String getErrorCodeSessionKey()

Deprecated.

setErrorTextSessionKey

public void setErrorTextSessionKey(String errorTextSessionKey)

Deprecated.

getErrorTextSessionKey

public String getErrorTextSessionKey()

Deprecated.

setErrorReasonSessionKey

public void setErrorReasonSessionKey(String errorReasonSessionKey)

Deprecated.

getErrorReasonSessionKey

public String getErrorReasonSessionKey()

Deprecated.

setServiceName

public void setServiceName(String serviceName)

Deprecated.

getServiceName

public String getServiceName()

Deprecated.

setActionName

public void setActionName(String actionName)

Deprecated.

getActionName

public String getActionName()

Deprecated.