XML Web service – Axis2 client & xml binding

In this example, we are going to invoke webservice and send complex Java objects
as input/output parameters to the web methods, usig Axis2 wsdl2java and 'xmlBeans' binding option.

Xml data binding, converts complex parameters sent as xml messages to pure java objects.
Axis2 mainly supports three types of xml data binding;

ADB - for axis2 web services only.

XMLBeans - supports non-axis webservices, with simple configuration, but somehow complex in coding.

JiBX - supports non-axis webservice, with simple coding, but requires much configuration.

Given the following webservice implementation, utilizing java.util.HashMap & custom object 'Student', as i/o parameters:

package complex;

public class StudentWS {

public StudentWS() {}

public Student selectStudent(String id)
{
Student student;
// student = get Student by id

return student;
}

public HashMap getAllStudents()
{
HashMap students=new HashMap();
// students = retrieve all students from DB
// students.put(student.getId(),stud.getName());

return students;
}

public void setAllStudents(HashMap students)
{
Iterator iter=students.keySet().iterator();
while(iter.hasNext())
{
// id = (String) iter.next();
// name = (String) students.get(id);
// Insert Id and Name into Student
}
}
}

where the Student class implemented at server side looks like this:

public class Student {

private String id;
private String name;

public Student(){}

public String getId()
{
return id;
}

public void setId(String id)
{
this.id=id;
}

public String getName()
{
return name;
}

public void setName(String name)
{
this.name=name;
}
}

having Axis2 installed and configured (as mentioned in the previous post),
we generate the client with xmlBeans binding, using this command:

wsdl2java -uri wsdlUrl -d xmlbeans
-o C:\client\xmlBeanBinding\complex

(Notice the additional option: -d xmlbeans
for xmlbeans binding).

this will generate client stub and the data types generated by axis2 xmlbeans binding,
at the output directory 'C:\client\xmlBeanBinding\complex'

to export client jars, we run ant command at the output directory "C:/Client/xmlBeans/complex",
then include jars in CLASSPATH of your client implementation.

Here's a sample code to invoke different methods of the ws;

import complex.Student;
import org.apache.xml.xml_soap.Item;
import org.apache.xml.xml_soap.Map;
import org.apache.xmlbeans.XmlString;
import complex.StudentWSServiceStub;
import complex.SetAllStudentsDocument;
import complex.SetAllStudentsResponseDocument;
import complex.GetAllStudentsDocument;
import complex.GetAllStudentsResponseDocument;
import complex.SelectStudentDocument;
import complex.SelectStudentResponseDocument;
import java.rmi.RemoteException;

public class Client {

public static void main(String[] args) {
try {

StudentWSServiceStub stub=new StudentWSServiceStub();
//selectStudent(stub);
//getAllStudents(stub);
//setAllStudents(stub);

} catch (RemoteException ex) {
ex.printStackTrace();
}
}

public static void selectStudent(StudentWSServiceStub stub) throws RemoteException
{
// create a msg to invoke selectStudent
SelectStudentDocument msgDoc = SelectStudentDocument.Factory.newInstance();
SelectStudentDocument.SelectStudent msg = msgDoc.addNewSelectStudent();

// set input parameter to "2"
msg.setId("2");

// invoke ws
SelectStudentResponseDocument resp = stub.selectStudent(msgDoc);

// method returns Student type generated by xmlbeans
Student student = resp.getSelectStudentResponse().getSelectStudentReturn();

//Note: to create new Student - Student.Factory.newInstance();

System.out.println("id: "+student.getId());
System.out.println("name: "+student.getName());
}


public static void getAllStudents(StudentWSServiceStub stub) throws RemoteException
{
GetAllStudentsDocument msgDoc = GetAllStudentsDocument.Factory.newInstance();
GetAllStudentsDocument.GetAllStudents msg = msgDoc.addNewGetAllStudents();

GetAllStudentsResponseDocument resp = stub.getAllStudents(msgDoc);

// method returns Map type simulating HashMap
Map students = resp.getGetAllStudentsResponse().getGetAllStudentsReturn();

for(int i=0;i<students.sizeofitemarray();i++)>
{
Item item=students.getItemArray(i);
XmlString id=(XmlString) item.getKey();
XmlString name=(XmlString) item.getValue();

System.out.println("id: "+id.getStringValue());
System.out.println("name: "+name.getStringValue());
}
}

public static void setAllStudents(StudentWSServiceStub stub) throws RemoteException
{
SetAllStudentsDocument msgDoc = SetAllStudentsDocument.Factory.newInstance();
SetAllStudentsDocument.SetAllStudents msg = msgDoc.addNewSetAllStudents();

// set a Map of students as input param
Map students=Map.Factory.newInstance();

// add item to the map
Item student1 = students.addNewItem();

XmlString id1 = XmlString.Factory.newInstance();
id1.setStringValue("1");
student1.setKey(id1);

XmlString name1 = XmlString.Factory.newInstance();
name1.setStringValue("Student One");
student1.setValue(name1);

Item student2=students.addNewItem();

XmlString id2=XmlString.Factory.newInstance();
id2.setStringValue("2");
student2.setKey(id2);

XmlString name2 = XmlString.Factory.newInstance();
name2.setStringValue("Student Two");
student2.setValue(name2);

// assign the students as input to the method
msg.setStudents(students);

// invoke ws
SetAllStudentsResponseDocument resp =
stub.setAllStudents(msgDoc);

System.out.println("Done :)");
}
}


Reference:
http://www.ibm.com/developerworks/webservices/library/ws-java3/