WSO2 ESB - How to use filter inside iterate mediator


WSO2 ESB's Iterate mediator plays a very powerful role in the Splitter Enterprise Integration Pattern. Splitter Enterprise Integration Pattern is used when messages contain multiple elements that might have to be processed in different ways. The Splitter breaks out the composite message into a series of individual messages, each containing data related to one item.

WSO2 ESB Iterate mediator split the message based on a given expression and process them separately. So think about a use case like you are getting multiple order items and you want to enrich each order item, by calling another endpoint and finally we need to aggregate all the enriched items.

There you can use the Iterate mediator and after that aggregate mediator to aggregate all the enriched items.

Example:


 ESB Proxy Service:

<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="IteService"
       transports="http,https"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <iterate id="aggregateid"
                  preservePayload="true"
                  attachPath="//Collection"
                  expression="//Collection/Job"
                  sequential="true">
            <target>
               <sequence>
                  <enrich>
                     <source type="body" clone="true"/>
                     <target type="property" property="originalRequest"/>
                  </enrich>
                  <payloadFactory media-type="xml">
                     <format>
                        <p:echoInt xmlns:p="http://echo.services.core.carbon.wso2.org">
                           <in>$1</in>
                        </p:echoInt>
                     </format>
                     <args>
                        <arg evaluator="xml" expression="$body/Collection/Job/Id"/>
                     </args>
                  </payloadFactory>
                  <property name="SOAPAction"
                            value="&#34;echoInt&#34;"
                            scope="transport"
                            type="STRING"/>
                  <call>
                     <endpoint>
                        <address uri="https://localhost:8243/services/echo"/>
                     </endpoint>
                  </call>
                  <property xmlns:ns="http://echo.services.core.carbon.wso2.org"
                            name="echoResponse"
                            expression="$body/ns:echoIntResponse"
                            scope="default"
                            type="OM"/>
                  <enrich>
                     <source type="property" clone="true" property="originalRequest"/>
                     <target type="body"/>
                  </enrich>
                  <enrich>
                     <source type="property" clone="true" property="echoResponse"/>
                     <target action="child" xpath="$body/Collection"/>
                  </enrich>
               </sequence>
            </target>
         </iterate>
         <property name="Collections" scope="default">
            <Collections xmlns=""/>
         </property>
         <aggregate id="aggregateid">
            <completeCondition>
               <messageCount min="-1" max="-1"/>
            </completeCondition>
            <onComplete expression="$body/Collection" enclosingElementProperty="Collections">
               <respond/>
            </onComplete>
         </aggregate>
      </inSequence>
   </target>
   <description/>
</proxy>


Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <Collection>
         <Job>
            <Id>12345</Id>
         </Job>
         <Job>
            <Id>12346</Id>
         </Job>
      </Collection>
   </soapenv:Body>
</soapenv:Envelope>


Let me expand this use case. Assume we just need to enrich some of the items only. To do that, we have to use filter mediator inside the Iterate mediator. If we update our existing code with the filter mediator logic, it will never reach to the aggregate on-complete logic. The reason is aggregate mediator waits for total messages that came into the iterate mediator, but due to the filter logic, some messages aren't supposed to be included in the aggregation. To avoid this, what we can do is, we have to define this Iterate mediator inside the In-Sequence and after all the logic inside the Iterate mediator( before the tag) you have to add a loopback mediator and need to move aggregate mediator into Out-Sequence. This will call the aggregate mediator for all the messages.

Example:

ESB Proxy Service:


<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="IteFilterService"
       transports="http,https"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <iterate id="aggregateid"
                  preservePayload="true"
                  attachPath="//Collection"
                  expression="//Collection/Job"
                  sequential="true">
            <target>
               <sequence>
                  <property name="JobId"
                            expression="string(//Job/Id)"
                            scope="default"
                            type="STRING"/>
                  <filter source="$ctx:JobId" regex="[0-9]+">
                     <log level="full">
                        <property name="JobId" expression="string(//Job/Id)"/>
                     </log>
                     <enrich>
                        <source type="body" clone="true"/>
                        <target type="property" property="originalRequest"/>
                     </enrich>
                     <payloadFactory media-type="xml">
                        <format>
                           <p:echoInt xmlns:p="http://echo.services.core.carbon.wso2.org">
                              <in>$1</in>
                           </p:echoInt>
                        </format>
                        <args>
                           <arg evaluator="xml" expression="$ctx:JobId"/>
                        </args>
                     </payloadFactory>
                     <property name="SOAPAction"
                               value="&#34;echoInt&#34;"
                               scope="transport"
                               type="STRING"/>
                     <call>
                        <endpoint>
                           <address uri="https://localhost:8243/services/echo"/>
                        </endpoint>
                     </call>
                     <property xmlns:ns="http://echo.services.core.carbon.wso2.org"
                               name="echoResponse"
                               expression="$body/ns:echoIntResponse"
                               scope="default"
                               type="OM"/>
                     <enrich>
                        <source type="property" clone="true" property="originalRequest"/>
                        <target type="body"/>
                     </enrich>
                     <enrich>
                        <source type="property" clone="true" property="echoResponse"/>
                        <target action="child" xpath="$body/Collection"/>
                     </enrich>
                  </filter>
                  <loopback/>
               </sequence>
            </target>
         </iterate>
      </inSequence>
      <outSequence>
         <property name="Collections" scope="default">
            <Collections xmlns=""/>
         </property>
         <aggregate id="aggregateid">
            <completeCondition>
               <messageCount min="-1" max="-1"/>
            </completeCondition>
            <onComplete expression="$body/Collection" enclosingElementProperty="Collections">
               <respond/>
            </onComplete>
         </aggregate>
      </outSequence>
   </target>
   <description/>
</proxy>

Request:


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <Collection>
         <Job>
            <Id>AAAA</Id>
         </Job>
         <Job>
            <Id>12345</Id>
         </Job>
         <Job>
            <Id>12346</Id>
         </Job>
      </Collection>
   </soapenv:Body>
</soapenv:Envelope>


Comments

silpion said…
The best example of iterate-aggregate WSO2 usage on the web :)
October 16, 2021 12:39 AM
Post a Comment

Popular posts from this blog

XSLT - Modify Date and DateTime value

If you want to perform date and time related opertions with XSLT 'date' or 'dateTime' values, you can use 'xs:yearMonthDuration' or 'xs:dayTimeDuration' function to achieve this. You can add or reduce years, months, date, hours or even minutes through those functions.  xs:yearMonthDuration For this function input value is year month duration and it should be passed in  ISO_8601 format n- the [n] is replaced by the value for each of the date and time elements P - The duration designator(for period). nY- the number of years. nM- the number of months. ex: xs:yearMonthDuration('P1Y2M') - 1 Year and 2 Months ex:  xs:yearMonthDuration('-P1Y2M')  - Negative 1 Year and 2 Months xs:dayTimeDuration For this function input value is day time duration and it also needs to be passed in  ISO_8601 format n- the [n] is replaced by the value for each of the date and time elements P - The duration designator(for period). nD- the
Read more

Integrate With Mutual Certificate Authentication based Service

There are many ways to secure a Service/API using different Authentication mechanisms. Mutual Certificate authentication(AKA: Client Certificate Authentication) is one of the ways to secure Service or API. Recently I was trying to integrate with an API which is secured using Mutual Certificate Authentication. In this scenario, the backend service team gave me their certificate-based on PKCS#12. When integrating this backend system with WSO2 Platform, we have to use 'Multi-HTTPS transport'. With this 'Multi-HTTPS transport', it will grant great flexibility to define different SSL profiles with separate trust stores and key stores for different IPs or hosts. This custom SSL profile can be implemented for Client to Synapse Runtime(Client --> ESB) or Synapse Runtime to Backend(ESB --> Backend). If it is Client to ESB, then you have to define custom SSL Profiles in the transportReceiver section. In my use-case, it was for ESB to Backend. So I had to add custom SSL prof
Read more

Yield Price Sri Lanka - Android Application

Image
" Yield Price Sri Lanka " is an Android based application which helps users to check Market Price Information using their mobile devices. This application concept is based on person X( will update his name after approvals) and I did slight modifications on the application to support in a low cost infrastructure. Using this " Yield Price Sri Lanka " application, you can check prices of various goods instantly, without going to the market. I am updating price information in Daily & Weekly basis according to the Colombo Manning Market prices. Initial application was developed to support English language only. With current latest version we are supporting English, Tamil and Sinhalese languages. This application will update price information in real time and when describing the application's back-end(server) architecture, it has developed to serve JSON based output with many concurrent requests without blocking any request. Within the mobile Application wh
Read more