So after defining the different xqueries and test them one by one in Eclipse all seem to work.
On runtime i get the next error :

The number of parameters for registered XQuery resource System1_To_Fault does not match that given to it at runtime

I was pretty sure after logging all the binded input variables they were all containing data.

Lesson learned : Make sure you both bind all the variables but also ‘use’ them in the xquery itself.
OSB will return this fault either when you don’t bind all the variables but also if you don’t use all of them in the xquery

xquery1 fragment (will work):

xquery version "1.0" encoding "Cp1252";

declare function xf:System1_To_Fault(
    $metadata1		      as xs:string,
    $metadata2		      as xs:string,
	$metadata3		      as xs:string)
    as element(soapenv:Fault) {
		<soapenv:Fault>
		<faultcode>soapenv:Server</faultcode>
		<faultstring>some description</faultstring>
		<faultactor>some string to the resource</faultactor>
		   <detail>
				<info1>{$metadata1}</info1>
				<info2>{$metadata2}</info3>
				<info3>{$metadata1}</info3>
		   </detail>
		</soapenv:Fault>
};

declare variable $metadata1 as xs:string external;
declare variable $metadata2 as xs:string external;
declare variable $metadata3 as xs:string external;

xf:System1_To_Fault($metadata1, $metadata2, $metadata3)

xquery2 fragment (will fail):

		<soapenv:Fault>
		<faultcode>soapenv:Server</faultcode>
		<faultstring>some description</faultstring>
		<faultactor>some string to the resource</faultactor>
		   <detail>
				<info1>{$metadata1}</info1>
				<info2>{$metadata2}</info2>
				<info3/>
		   </detail>
		</soapenv:Fault>

inputvariable ‘metadata3′ isn’t used in the xquery itself, so the dynamix xquery will fail on runtime
either make sure you always use all the input variables in the xquery (or do an expression on it, for example assign it to an temp variable but don’t use it for generating your target xml)
something like this

    	let $temp := $metadata3
    	return
   			<soapenv:Fault>
			<faultcode>soapenv:Server</faultcode>
			<faultstring>some description</faultstring>
			<faultactor>some string to the resource</faultactor>
		   	<detail>
				<info1>{$metadata1}</info1>
				<info2>{$metadata2}</info2>
				<info3/>
		   	</detail>
			</soapenv:Fault>

I’m not sure what this assign will do (performance-wise) when you assign a big dom-tree variable, in that case you could just assign the deepest childnode to the temp variable.
Eventually it’s just a dirty fix to be able to use the xqueries in combination with dynamic xquery and still be able to not use all of the incoming parameters.

First we need to create a new queue in Weblogic, in my case QueueuIn.

1. Create the java entity object

Create the next entity object

package nl.xenta.entities;

import java.io.Serializable;

public class Employee  implements Serializable {

	private static final long serialVersionUID = -5802550970297576366L;
	public String firstname;
	public String lastname;
	public Integer age;

	public String getFirstname() {
		return firstname;
	}
	public void setFirstname(String firstname) {
		this.firstname = firstname;
	}
	public String getLastname() {
		return lastname;
	}
	public void setLastname(String lastname) {
		this.lastname = lastname;
	}
	public Integer getAge() {
		return age;
	}
	public void setAge(Integer age) {
		this.age = age;
	}
}

Build it and generate a jar file from it.

2. Client to send Java Object Message

package nl.xenta.utilities;

import java.util.Hashtable;

import javax.jms.Message;
import javax.jms.ObjectMessage;
import javax.jms.Queue;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import javax.jms.QueueReceiver;
import javax.jms.QueueSender;
import javax.jms.QueueSession;
import javax.jms.Session;
import javax.naming.Context;
import javax.naming.InitialContext;

import nl.xenta.entities.Employee;
import nl.xenta.entities.Person;
import nl.xenta.services.EmployeeService;

public class JmsHelper {

	public final static String JNDI_FACTORY = "weblogic.jndi.WLInitialContextFactory";
	public final static String JMS_FACTORY = "javax.jms.QueueConnectionFactory";
	public final static String QUEUE = "QueueIn";

	static QueueConnectionFactory factory;
	static QueueConnection qconnection;
	static QueueSession qsession;
	static QueueReceiver qreceiver;
	static Queue queue;
	static Context ctx;
	private boolean quit = false;

	/**
	 * @param args
	 * @throws Exception
	 */
	public static void sendMessage() throws Exception {
		QueueConnection queueCon = null;
		try {
			// get the initial context, refer to your app server docs for this
			Hashtable<String, String> ht = new Hashtable<String, String>();
			ht.put(Context.INITIAL_CONTEXT_FACTORY,
					"weblogic.jndi.WLInitialContextFactory");
			ht.put(Context.PROVIDER_URL, "t3://localhost:7001");
			Context ctx = new InitialContext(ht);

			// get the connection factory, and open a connection
			QueueConnectionFactory qcf = (QueueConnectionFactory) ctx
					.lookup("weblogic/jms/XAConnectionFactory");
			queueCon = qcf.createQueueConnection();

			// create queue session off the connection
			QueueSession queueSession = queueCon.createQueueSession(false,
					Session.AUTO_ACKNOWLEDGE);

			// get handle on queue, create a sender and send the message
			Queue queue = (Queue) ctx.lookup(QUEUE);
			QueueSender sender = queueSession.createSender(queue);

			// create employee object
			Employee emp = new Employee();
			emp.setAge(32);
			emp.setFirstname("Eric");
			emp.setLastname("Elzinga");

			// send java object to queue
			Message msg = queueSession.createObjectMessage(emp);
			sender.send(msg);

			System.out.println("Send Java Object Message");
		} finally {
			// close the queue connection
			if (queueCon != null) {
				queueCon.close();
			}
		}
	}
}

Execute the jms java client to create Employee object and store it on the QueueIn queue.
Go to the Weblogic Console to see if the message arrived in the QueueIn queue.

When we now click on the message it will give the next message

	Unable to view message, reason = java.lang.ClassNotFoundException: nl.xenta.entities.Employee

Copy the builded jar from step1 (the jar with the compiled Employee class in it) to the next location

	YOUR_MIDDLEWARE_HOME/user_projects/domains/osb_domain/lib

Restart Weblogic and try viewing the message in the console again.

Great, it worked. Now we can see a Employee object is stored in the queue.
Let’s go on with the OSB part.

3. Oracle Service Bus Proxy Service

1. First copy the jar created in step 2 to our OSB project.
2. Create a new Messaging Proxy Service
   
3. Select ‘Java’ for Request Message Type
   
4. Use jms protocol and configure the endpoint (use the just created queue)
   
   Select Queue for Destination Type
   
   Configure the Client Jar and browse to the jar file generated in step 2.

   If we skip this settings the proxyservice won’t be able to deserialize the java objects retrieved from the queue. Resulting in stacktraces like this

   ####<Aug 28, 2011 10:23:56 AM CEST> <Error> <OSB Kernel> <multimedia> <AdminServer> <[ACTIVE] ExecuteThread: '26' for queue: 'weblogic.kernel.Default (self-tuning)'> <<anonymous>> <BEA1-03E7A5A49D452A912D4B> <1bf9ba3a756c6ce8:6b05e983:1320f4d10ed:-8000-00000000000000bb> <1314519836078> <BEA-380003> <Exception on TransportManagerImpl.receiveMessage, com.bea.wli.sb.context.BindingLayerException: General runtime error: [JMSClientExceptions:055115]Error deserializing an object
   com.bea.wli.sb.context.BindingLayerException: General runtime error: [JMSClientExceptions:055115]Error deserializing an object
   
   Caused By: java.lang.ClassNotFoundException: nl.xenta.entities.Employee
   	at java.net.URLClassLoader$1.run(URLClassLoader.java:202)
   

5. Create the Message Flow as defined in the picture and only add a log activity, which logs the body.
   

Deploy the process and use the JmsHelper client to create an Employee object and send it to the queue.
The proxy service will poll, get it out of the queue and basically does nothing with it except logging the body.
After the message is send, check the osb domain log file to see what’s in the $body variable.

<BEA-000000> < [PipelinePairNode1, PipelinePairNode1_request, stage2, REQUEST] ### debug logging $body ###: <soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <con:java-content ref="jcid:4c741db6:131dd1e4544:-7fc5" xmlns:con="http://www.bea.com/wli/sb/context"/>
</soapenv:Body>>

The java object is retrieved from the queue and processed by the proxy service.
But when we look in the body we don’t see any ‘actual’ payload, only a java ref to the java object itself.

Let’s use a few java callouts to see how we can use the content of the java object.

4. Proxyservice, java callout, java (object) in, string out

Extend the java project from step1.
Create a new class (EmployeeService) with the next method (convertEmployeeToString) in it

package nl.xenta.services;

import java.io.File;
import java.io.IOException;

import org.apache.xmlbeans.XmlException;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions;

import nl.xenta.crm.employee.EmployeeDocument;
import nl.xenta.crm.employee.EmployeeType;
import nl.xenta.entities.Employee;
import nl.xenta.entities.Person;

public class EmployeeService {

	public static String convertEmployeeToString(Employee employee) {
		return employee.toString();
	}
}

The input Employee object will be the data from the queue and as response we just return the string value of the object.
Generate a jar archive from it and store it in your OSB project.

Add the java callout to your proxy service message flow and after it add the log activity.
The log activity will just log the value of $my_string_response.

Now trigger the process again by sending a message with the JmsHelper client and check the osb log file.

<BEA-000000> < [PipelinePairNode1, PipelinePairNode1_request, stage2, REQUEST] ### JMSObject_ps, logging string response after the java callout ###: Employee [firstname=Eric, lastname=Elzinga, age=32]>

Read this for some extra information about the java callouts and their input and return types.
“The input and return types for Java callouts are not restricted. However, any return types other than primitives, Strings, or XmlObjects can only be passed (unmodified) to other Java callouts.”
In this example we get a String returned, so we can just retrieve the value of it in the message flow without sending it to another java callout.

5. Proxyservice, java (object) in, java (object) out

For this example i made a copy of the Employee object and named it Person. We will use the same Employee object as example1 for the input and return a Person object back to OSB and log this.

	public static Person convertEmployeeToPerson(Employee employee) {
		Person person = new Person();

		person.setFirstname(employee.firstname);
		person.setLastname(employee.lastname);
		person.setAge(employee.age);

		return person;
	}

<BEA-000000> < [PipelinePairNode1, PipelinePairNode1_request, stage2, REQUEST] ### JMSObject_ps, logging person response after the java callout ###: <con:java-content ref="jcid:4cd600ef:131e1eeb1b1:-7fca" xmlns:con="http://www.bea.com/wli/sb/context"/>>

And again we get a java ref back, only this time a new ref id to a new object.
To be able to ‘use’ this object we can either send it to a new java callout or publish it to another queue.

6. Proxyservice, java (object) in, XmlObject out

See this blog on how to send the java object to a java callout and return a XmlObject back.
I added the XMLBeans resources (build.xml and libs) to the same project as mentioned in step1.

For this testcase we used the next method. It will receive the Employee object from the queue and return the xml(object) representation of it back to the OSB.

	public static XmlObject convertJavaToXml(Employee employee) throws Exception {
		EmployeeDocument empDoc = EmployeeDocument.Factory.newInstance();
		EmployeeType myEmp = empDoc.addNewEmployee();
		myEmp.setAge(32);
		myEmp.setFirstName("Eric");
		myEmp.setLastName("Elzinga");

		return myEmp;
	}

Run the ant build script again and copy the jar to our OSB project.
In this jar we will find the Employee and Person entities, the generated XMLBeans artifacts and the static methods used for the java callout. I guess we could have splitted some of those in other archives, but for the simplicity of this article it’s fine like this.
The jar we used in the other cases won’t be needed anymore since all we need is in this new one.

Don’t forget to edit the proxyservice and change the Client Jar to the new jar.

And the java callout

<BEA-000000> < [PipelinePairNode1, PipelinePairNode1_request, stage2, REQUEST] ### JMSObject_ps, logging my_employee_xml response after the java callout ###: <emp:employee xmlns:emp="http://xenta.nl/crm/employee">
  <emp:FirstName>Eric</emp:FirstName>
  <emp:LastName>Elzinga</emp:LastName>
  <emp:Age>32</emp:Age>
</emp:employee>>

With this final testcase we’re able to retrieve the java object from the queue, convert it to a xml representation and send it back to the proxy service.
In the message flow we’re now able to retrieve data from it by use of some xpath expression.

There are 2 situations which will differ in the way we get the data returned back from the java callout, see this

Return primitives, Strings or XmlObjects from the java callout.
In this case we can just retrieve the data from the $body variable and execute xpath expressions on it to immediately get the value of the payload.

Return anything else
In this case we will get back a java ref identifier back from the java callout.
Executing xpath expressions on the $body will only give use a reference to the java object

<BEA-000000> < [PipelinePairNode1, PipelinePairNode1_request, stage2, REQUEST] ### debug logging $body ###: <soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <con:java-content ref="jcid:4c741db6:131dd1e4544:-7fc5" xmlns:con="http://www.bea.com/wli/sb/context"/>
</soapenv:Body>>

To be able to use the data in the java object we can only pass it to other java callouts.

In this blog i will show an example of how to generate a XmlObject, mentioned as one of the return types in case 1.
If we’re able to generate this kind of object from the java callout, OSB will just be able to retrieve this in the $body variable and let us execute xpath expression on it.

1. Create a Java project in Eclipse

We will be using XML Beans to generate the java artifacts based on a Employee schema definition.
These artificats we will be using in our static method to generate the Employee java objects which represents our Employee entity definition from the xsd schema.
Read this and this to get a quickstart on XML Beans.

1. In Eclipse we will create a new java project with a dependency on the Apache XML Beans library.
   I copied the ORACLE_MIDDLEWARE_HOME\modules\com.bea.core.xml.xmlbeans_2.1.0.0_2-5-1.jar to my lib folder in the project.
   Add the same file as build dependency (libraries) in the project properties.

2. Create a schemas folder in the root and add the Employee.xsd to it

   <?xml version="1.0" encoding="UTF-8"?>
   <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:emp="http://xenta.nl/crm/employee" targetNamespace="http://xenta.nl/crm/employee" elementFormDefault="qualified" attributeFormDefault="unqualified">
   	<xs:element name="employee" type="emp:EmployeeType">
   		<xs:annotation>
   			<xs:documentation>Employee entity</xs:documentation>
   		</xs:annotation>
   	</xs:element>
   	<xs:complexType name="EmployeeType">
   		<xs:sequence>
   			<xs:element name="FirstName" type="xs:string"/>
   			<xs:element name="LastName" type="xs:string"/>
   			<xs:element name="Age" type="xs:int"/>
   		</xs:sequence>
   	</xs:complexType>
   </xs:schema>
   

3. Create a build.xml in the root of the project. I used the one mentioned in the quickstart articles and edited it a bit.

   	<?xml version="1.0" encoding="UTF-8"?>
   	<project name="XMLBeansDemo" default="build">
   		<property environment="env"/>
   
   		<path id="Any.path">
   			<path refid="xmlbeans.path"/>
   			<fileset dir="build/lib" includes="*.jar"/>
   			<pathelement path="build/classes"/>
   		</path>
   
   		<target name="init">
   			<property name="xmlbeans.home" value="e:\osb_workspace\EmployeeXmlBeans\"/>    	
   
   			<echo message="xmlbeans.home: ${xmlbeans.home}"/>
   
   			<!-- check for xbean.jar from binary distribution -->
   
   			<available
   				property="xmlbeans.lib"
   				value="${xmlbeans.home}/lib"
   				file="${xmlbeans.home}/lib/com.bea.core.xml.xmlbeans_2.1.0.0_2-5-1.jar" />
   
   			<fail message="Set XMLBEANS_HOME in your environment."
   				unless="xmlbeans.lib"/>
   
   			<echo message="xmlbeans.lib: ${xmlbeans.lib}"/>
   
   			<path id="xmlbeans.path">
   				<fileset dir="${xmlbeans.lib}" includes="*.jar"/>
   			</path>
   
   			<taskdef name="xmlbean"
   				classname="org.apache.xmlbeans.impl.tool.XMLBean"
   				classpathref="xmlbeans.path"/>
   		</target>
   
   		<!-- ========================== clean ==== -->
   
   		<target name="clean">
   			<delete dir="build"/>
   		</target>
   
   		<!-- ========================== build ==== -->
   
   		<target name="build" depends="init,schemas.jar,Any.classes">
   		</target>
   
   		<target name="schemas.check">
   			<uptodate property="schemas.notRequired"
   				targetfile="build/lib/EmployeeXmlBeans.jar">
   				<srcfiles dir="schemas" includes="**/*.xsd"/>
   			</uptodate>
   		</target>
   
   		<target name="schemas.jar" depends="init,schemas.check"
   			unless="schemas.notRequired">
   			<mkdir dir="build/lib"/>
   			<xmlbean schema="schemas"
   				destfile="build/lib/EmployeeXmlBeans.jar"
   				srcgendir="src"
   				classpathref="xmlbeans.path"
   				source="1.5"
   				javasource="1.5"
   				debug="on"
   				/>
   		</target>
   
   		<target name="Any.classes" depends="init">
   			<mkdir dir="build/classes"/>
   
   			<javac srcdir="src"
   				destdir="build/classes"
   				classpathref="Any.path"
   				debug="on"
   				source="1.5"
   				/>
   		</target>
   
   		<!-- ========================== run ==== -->
   
   		<target name="run" depends="init,build">
   			<echo message="============================== running Any"/>
   			<java
   				classname="org.apache.xmlbeans.samples.anytype.Any"
   				classpathref="Any.path"
   				fork="true">
   				<arg line="xml/any.xml"/>
   			</java>
   		</target>
   
   		<!-- ========================== test ==== -->
   
   		<target name="test" depends="init,build">
   			<echo message="============================== testing Any"/>
   			<java
   				classname="org.apache.xmlbeans.samples.anytype.AnyTest"
   				classpathref="Any.path"
   				fork="true">
   				<arg line="xml/any.xml"/>
   			</java>
   		</target>
   
   	</project>
   

   Run the ant build script. Based on the xml namespace of the Employee xsd object it will generate the same package structure for the java objects.
   Verify if it generated the next list of objects

   • nl.xenta.crm.employee.EmployeeDocument
   • nl.xenta.crm.employee.EmployeeType
   • nl.xenta.crm.employee.impl.EmployeeDocumentImpl
   • nl.xenta.crm.employee.impl.EmployeeDocumentImpl

   And if it also generated the file EmployeeXmlBeans.jar in the lib folder.

4. Next we need to create a static method which will make use of the generated classes.
   Create the next class in the same project

   package nl.xenta.services;
   
   import org.apache.xmlbeans.XmlObject;
   
   import nl.xenta.crm.employee.EmployeeDocument;
   import nl.xenta.crm.employee.EmployeeType;
   import nl.xenta.entities.Employee;
   import nl.xenta.entities.Person;
   
   public class EmployeeService {
   
   	/**
   	 * Retrieve an employee record based on an employee id and return a XmlObject
   	 *
   	 * @param empId
   	 *
   	 * @return Employee XmlObject
   	 */
   	public static XmlObject retrieveEmployee(String empId) {
   		EmployeeDocument empDoc = EmployeeDocument.Factory.newInstance();
   		EmployeeType myEmp = empDoc.addNewEmployee();
   		myEmp.setAge(32);
   		myEmp.setFirstName("Eric");
   		myEmp.setLastName("Elzinga");
   
   		return myEmp;
   	}
   }
   

5. Run the ant build again and this time copy the EmployeeXmlBeans.jar file to your OSB project and refresh the project in Eclipse.
6. Add the java callout to your proxy service message flow and see the response
   
7. Test the proxyservice and see the response in the logging.

   <BEA-000000> < [PipelinePairNode1, PipelinePairNode1_request, RetrieveEmployee, REQUEST] ### debug, logging my_employee_xml_object ###: <emp:employee xmlns:emp="http://xenta.nl/crm/employee">
     <emp:FirstName>Eric</emp:FirstName>
     <emp:LastName>Elzinga</emp:LastName>
     <emp:Age>32</emp:Age>
   </emp:employee>>
   

Now we’re able to retrieve data from the variable just by using the xpath expressions and re-use it in the rest of the message flow.

]]> http://www.xenta.nl/blog/2011/08/29/oracle-service-bus-java-callouts-with-xmlobjects/feed/ 10 http://www.xenta.nl/blog/2011/07/03/oracle-service-bus-implementing-aggregator-pattern-by-use-of-split-join/ http://www.xenta.nl/blog/2011/07/03/oracle-service-bus-implementing-aggregator-pattern-by-use-of-split-join/#comments Sun, 03 Jul 2011 07:26:45 +0000 Eric Elzinga http://www.xenta.nl/blog/?p=1333 One of the patterns mentioned on the eai patterns site is the so called Aggregator pattern.

“Use a stateful filter, an Aggregator, to collect and store individual messages until a complete set of related messages has been received. Then, the Aggregator publishes a single message distilled from the individual messages”

We will be using this pattern in our next use case.

Use case

On the Oracle Service Bus we will implement the EmployeeService with an operation called ‘getEmployee’.
When we call this operation and supply an input parameters of the EmployeeNumber, we want to receive the next set of information

• EmployeeDetails
• AddressDetails
• ContactDetails

In a real life scenario we could have the next situation


On the Oracle Service Bus we want to supply our clients 1 interface to be able to retrieve Employee information. The interface definition will define Employee details, addresses and contact details.

The process will receive the Employee Number, and by use of parallel invocation it will :

• send a request to system1 which will supply us the Employee details
• send a request to system2 which will suppy us the Employee addresses
• send a request to system3 which will supply us the Employee contact details

Every system invocation will be a synchronous call and will get a response back from every one of them.
After having received the last of the 3 responses the parallel invocation is done. In the process flow we now need to aggregate the responses and transform these into one response which will get routed back to the client caller.

The client caller will not know what backend systems will get invoked to retrieve data. It will only receive one message response according to our defined interface on the service bus.

Enough talk, let’s see what we need in the Oracle Service Bus to implement this.

Backend systems

In a real world situation we could have 3 different backend systems which will all supply diffent parts of the Employee data object. For our case we will use just 1 webservice with different operations which will get invoked as different services.
Create a new Webservice project in Eclipse and add a new webservice to see.

package nl.xenta.services;

import nl.xenta.entities.Address;
import nl.xenta.entities.ContactDetail;
import nl.xenta.entities.Employee;

public interface EmployeeService {

	public Employee getEmployeeDetails(String employeeNumber);

	public Address getEmployeeAddress(String employeeNumber);

	public ContactDetail getContactDetail(String employeeNumber);

}

package nl.xenta.services;

import javax.jws.*;

import nl.xenta.entities.Address;
import nl.xenta.entities.Employee;
import nl.xenta.entities.ContactDetail;

@WebService
public class EmployeeServiceImpl implements EmployeeService {

	/* (non-Javadoc)
	 * @see nl.xenta.services.EmployeeService#getEmployeeDetails(java.lang.String)
	 */
	@WebMethod
	public Employee getEmployeeDetails(@WebParam(name="employeeNumber") String employeeNumber) {
		Employee emp = new Employee();
		emp.setFirstname("Eric");
		emp.setLastname("Elzinga");
		emp.setId(100);

		return emp;
	}

	/* (non-Javadoc)
	 * @see nl.xenta.services.EmployeeService#getEmployeeAddress(java.lang.String)
	 */
	@WebMethod
	public Address getEmployeeAddress(@WebParam(name="employeeNumber") String employeeNumber) {
		Address address = new Address();
		address.setCity("Utrecht");
		address.setCountry("The Netherlands");
		address.setPostalCode("1413JK");

		return address;
	}

	/* (non-Javadoc)
	 * @see nl.xenta.services.EmployeeService#getContactDetail(java.lang.String)
	 */
	@WebMethod
	public ContactDetail getContactDetail(@WebParam(name="employeeNumber") String employeeNumber) {
		ContactDetail contact = new ContactDetail();
		contact.setType("mobile");
		contact.setValue("+31(6)24562772");		

		return contact;
	}
}

package nl.xenta.entities;

public class Address {

	private String street;
	private String postalCode;
	private String city;
	private String country;

	public String getStreet() {
		return street;
	}
	public void setStreet(String street) {
		this.street = street;
	}
	public String getPostalCode() {
		return postalCode;
	}
	public void setPostalCode(String postalCode) {
		this.postalCode = postalCode;
	}
	public String getCity() {
		return city;
	}
	public void setCity(String city) {
		this.city = city;
	}
	public String getCountry() {
		return country;
	}
	public void setCountry(String country) {
		this.country = country;
	}
}

package nl.xenta.entities;

public class ContactDetail {

	String type;
	String value;
	public String getType() {
		return type;
	}
	public void setType(String type) {
		this.type = type;
	}
	public String getValue() {
		return value;
	}
	public void setValue(String value) {
		this.value = value;
	}
}

package nl.xenta.entities;

public class Employee {

	private int id;
	private String firstname;
	private String lastname;

	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public String getFirstname() {
		return firstname;
	}
	public void setFirstname(String firstname) {
		this.firstname = firstname;
	}
	public String getLastname() {
		return lastname;
	}
	public void setLastname(String lastname) {
		this.lastname = lastname;
	}
}

Deploy the service
The simulated backend systems are ready to supply data.

Oracle Service Bus resources

We need to next list of resources in the Oracle Service Bus to be able to implement the process.

• wsdl + xsd of the deployed EmployeeService java webservice
• business services for every third party service
• split-join for the aggregation
• business service representing the split-join
• proxy service which routes to the split-join business service

Wsdl and xsd

Import the wsdl from the wsdl endpoint shown in the Weblogic Console

Business services for every third party service

Since we have just 1 webservice representing all the third parties we don’t really need to create separate business services for every party. To simulate the real scenario we still create 3 separate business services, all based on the same wsdl, but in the routing we will just use different operations.
So create the next set of business services all based on the same EmployeeService wsdl (which we imported in the step before).

• AddressDetails.biz
• ContactDetails.biz
• EmployeeDetails.biz

Split-join

Create a new wsdl for the interface of the split-join. This wsdl will only represent the getEmployee operation. Name the wsdl CRM_EmployeeService.wsdl.

<!-- Published by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is Oracle JAX-WS 2.1.5. --><!-- Generated by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is Oracle JAX-WS 2.1.5. --><definitions name="EmployeeServiceService" targetNamespace="http://services.xenta.nl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://services.xenta.nl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/">
	<types>
		<xsd:schema>
			<xsd:import namespace="http://services.xenta.nl/" schemaLocation="EmployeeService.xsd"/>
		</xsd:schema>
	</types>
	<message name="getEmployee">
		<part name="parameters" element="tns:getEmployee"/>
	</message>
	<message name="getEmployeeResponse">
		<part name="parameters" element="tns:getEmployeeResponse"/>
	</message>
	<portType name="CRM_EmployeeService">
		<operation name="getEmployee">
			<input message="tns:getEmployee"/>
			<output message="tns:getEmployeeResponse"/>
		</operation>
	</portType>
	<binding name="EmployeeServicePortBinding" type="tns:CRM_EmployeeService">
		<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
		<operation name="getEmployee">
			<soap:operation soapAction=""/>
			<input>
				<soap:body use="literal"/>
			</input>
			<output>
				<soap:body use="literal"/>
			</output>
		</operation>
	</binding>
	<service name="EmployeeServiceService">
		<port name="EmployeeServicePort" binding="tns:EmployeeServicePortBinding">
			<soap:address location="http://192.168.178.28:7001/EmployeeService/EmployeeServiceService"/>
		</port>
	</service>
</definitions>

<?xml version="1.0" encoding="UTF-8"?>
<!-- Published by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is Oracle JAX-WS 2.1.5. -->
<xs:schema xmlns:tns="http://services.xenta.nl/" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://services.xenta.nl/" version="1.0">
	<xs:element name="getEmployee" type="tns:getEmployee"/>
	<xs:element name="getEmployeeResponse" type="tns:getEmployeeResponse"/>
	<xs:complexType name="getEmployee">
		<xs:sequence>
			<xs:element name="employeeNumber" type="xs:string" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="getEmployeeResponse">
		<xs:sequence>
			<xs:element name="EmployeeDetails" type="tns:employeeDetailType" minOccurs="0"/>
			<xs:element name="AddressDetails" type="tns:contactDetailType" minOccurs="0"/>
			<xs:element name="ContactDetails" type="tns:addressDetailType" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="contactDetailType">
		<xs:sequence>
			<xs:element name="type" type="xs:string" minOccurs="0"/>
			<xs:element name="value" type="xs:string" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="employeeDetailType">
		<xs:sequence>
			<xs:element name="firstname" type="xs:string" minOccurs="0"/>
			<xs:element name="id" type="xs:int"/>
			<xs:element name="lastname" type="xs:string" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="addressDetailType">
		<xs:sequence>
			<xs:element name="city" type="xs:string" minOccurs="0"/>
			<xs:element name="country" type="xs:string" minOccurs="0"/>
			<xs:element name="postalCode" type="xs:string" minOccurs="0"/>
			<xs:element name="street" type="xs:string" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
</xs:schema>

Create a new split join (File | New | Split-Join) and name it EmployeeSplitJoin.


By default it will generate for us the variables request and response.


Add a Parallel activity between Receive and Reply.
Add an extra Branch to the Parallel activity.
In every Scope and a Invoke Service activity.
Select the first Invoke Service in the first Scope and configure it.
On the Operation tab, browse to the first business service, AddressDetails.


On the Input Variable tab, select for Message Variable the option Create Message Variable.

Name the variable EmployeeAddressRequest and define it as Global Variable


Do the same for the Output Variable tab and name the variable EmployeeAddressResponse.

In every Scope add an assign before every Invoke Service activity.

With these assigns we’re mapping the inputparameter of our process (employeeNumber) to the input of our business service (backend service).

Repeat these steps (add scope, add assign, add invoke service, configure input/output of invoke service) for every invocation of our business services.
We should end up with the next set of branches.


The parallel invocation of our backend services is ready. Now we need to aggregate the responses of all the services. Create a new xquery transformation which will receive 3 inputparameters, one for every response of our backend service. The result of the transformation will be a message according to our proxy service interface (getEmployee).




After the Parallel activity add an Assign. Click the expression and go to the XQuery Resources tab and browse to the ServicesToAggregatedResponse xquery. Bind all the input parameters as defined in the image below.

For the Variable select response.parameters.

Our split-join part of the process is done. The process flow should look a bit like this :


To be able the call the split-join flow we need to generate a business out of it. Right click on the EmployeeSplitJoin.flow and go to File | Oracle Service Bus | Generate Business Service, name it EmployeeSplitJoin.

ProxyService

Create a new http soap proxy service based on the CRM_EmployeeService wsdl. In the proxyservice route to the ‘EmployeeSplitJoin’ business service. Since the interface of our split-join is the same as our proxy service (same wsdl) we can just use the passthrough, no transformation is needed.
Deploy the project and and test the service


Conclusion

Instead of using the split-join we can also use several service call outs in our process. Downside on this approach is all the invokes will be waiting on each other to come back with response (sequential). With the split-join approach we can parallel invoke all the services an aggregate the results. In case of services which need to give a low response time and still need to retrieve data from multiple backend systems we can’t model the flow with sequential invocations, split-join would then be an approach to take.

Besides that static split-join i used for my case we can also use the dynamic apporach in which we loop over reoccuring elements in the payload, process them parallel an aggregate the results.
Edwin showed this approach in his blog.

]]> http://www.xenta.nl/blog/2011/07/03/oracle-service-bus-implementing-aggregator-pattern-by-use-of-split-join/feed/ 2