Class BisJmsListener

All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, HasSender, IConfigurable, IJmsListener<jakarta.jms.Message>, IKnowsDeliveryCount<jakarta.jms.Message>, IListener<jakarta.jms.Message>, IPortConnectedListener<jakarta.jms.Message>, IPushingListener<jakarta.jms.Message>, IRedeliveringListener<jakarta.jms.Message>, IScopeProvider, IThreadCountControllable, IWithParameters, IXAEnabled, NameAware, ReceiverAware<jakarta.jms.Message>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Deprecated @ConfigurationWarning("Please change to JmsListener combined with BisWrapperPipe") public class BisJmsListener extends JmsListener
Deprecated.
Please use JmsListener combined with BisWrapperPipe
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
  • Constructor Details

    • BisJmsListener

      public BisJmsListener()
      Deprecated.
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Deprecated.
      Description copied from interface: IConfigurable
      Configure this component.

      configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class PushingJmsListener
      Throws:
      ConfigurationException - in case it was not able to configure the component.
    • extractMessageBody

      public Message extractMessageBody(Message message, Map<String,Object> context, SoapWrapper soapWrapper) throws SAXException, TransformerException, IOException, XmlException
      Deprecated.
      Overrides:
      extractMessageBody in class JMSFacade
      Throws:
      SAXException
      TransformerException
      IOException
      XmlException
    • prepareReply

      public Message prepareReply(Message rawReply, Map<String,Object> threadContext) throws ListenerException
      Deprecated.
      Overrides:
      prepareReply in class AbstractJmsListener
      Throws:
      ListenerException
    • prepareResult

      public String prepareResult(String errorCode, Map<String,Object> threadContext)
      Deprecated.
    • 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.
attributesdescriptiondefault
classNameorg.frankframework.extensions.bis.BisSoapJmsListener 
soapwhen true, messages sent are put in a SOAP envelopetrue
requestXPathxpath 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) 
requestNamespaceDefsnamespace defintions for requestXPath. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions 
messageHeaderInSoapBodywhen true, the MessageHeader is put in the SOAP body instead of in the SOAP header (first one is the old BIS standard)false
resultInPayloadwhen 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
omitResultwhen 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
removeRequestNamespaceswhen set true namespaces (and prefixes) in the request are removed (this functionality will be used during migration from IFSA to TIBCO)false
layByNamespacewhen 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
errorCodeSessionKeykey of session variable to store error code in (if an error occurs)bisErrorCode
errorTextSessionKeykey 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:
errorCodeerrorText
ERR6002Service Interface Request Time Out
ERR6003Invalid Request Message
ERR6004Invalid Backend system response
ERR6005Backend system failure response
ERR6999Unspecified Errors
 
errorReasonSessionKeykey of session variable to store error reason in (if an error occurs)bisErrorReason
serviceNamename of the service; used in the error reply 
actionNamename of the operation; used in the error reply