Wednesday, July 24, 2013

opentravel web service - simple example

I'm going to show you how easy it is to write a REST and SOAP web service for opentravel messages using open source software.

By leveraging open source software, most of the difficult code is already written. All you have to do is implement a java interface to service the web service calls.

You don't have to worry about messy xml handling, you work with java classes. The framework does the work for you.

For this example we'll assume that you are a local sightseeing company. Your customers want to be able to access real-time pricing and availability for all of our tours.

They use the opentravel 2013A Tour Activity Availability message pair using SOAP and REST over HTTP.

This means you need a web server, a SOAP processing module, and a schema parser, as well as your code. Luckily open source software does most this.

If you're impatient and you just want this demo up and running with a just a few commands, click here for the schema library rest example.

I've created a template for your sample project. To create your project from this template, start eclipse and select:

File -> New -> Project -> Maven Project
On the Archetype screen, select the archetype: opentravel-touractivity-ws-service-archetype. If the artifact doesn't appear, click the 'add archetype' button; GroupId:, ArtifactId: opentravel-touractivity-ws-service-archetype, Version: 1.1.1 (Not the version show in this image)

On the Project screen, enter your group, artifact name, and version.

You can enter anything you want here. You will need your project group, artifact, and version when you deploy your project.
Click finish to build your project.

This project has three files.

The pom files is the maven project file. You will need to update the parent version number to version 1.1.1. The start of your pom file should look like this:

The blueprint.xml file is the configuration file. This blueprint tells the system to register this service to handle opentravel touractivity messages.

The source file handles the actual messages. This code is expected to process request messages and return a response.

If you look at the source code, you will find the method:
public AvailRS avail(AvailRQ request)
I have included some sample code that returns availability and pricing for several fake tours. This is where you would access your inventory and pricing and populate the return message.
The cool part of using a java representation of the opentravel xml message is you can use all the eclipse programming shortcuts, such as auto-complete and documentation display. All the comments and xml snippets from the (complex) opentravel schema have been transferred to the java source code. Try to ctrl-click one of the request or response method names and you will be looking at the java source code model of the xml message.

To build the project, right-click the project name in the project explorer and select Run as -> Maven install

Now we are ready to deploy this code.

For this example, I'll use apache karaf and cxf. You can also use any one of the enhanced esb servers such as Talend or Fuse. In fact, this code uses only open specifications, so you should be able to run it with minor configuration changes on almost any java app server.

Download karaf, unzip, and run it:

tar zxvf apache-karaf-2.3.2.tar.gz
cd apache-karaf-2.3.2
First, install apache cxf and a few support bundles.
features:addurl mvn:org.apache.cxf.karaf/apache-cxf/2.7.6/xml/features
features:install cxf cxf-databinding-jibx http obr
Now start the RESTful server and the SOAP server. These servers are configured to send incoming messages to a service registered to handle touractivity messages. (The blueprint.xml file does this) Type these command into the servicemix console.
obr:start -d
obr:start -d

# Enter the actual group/artifact/version of your project here:

Give it a moment to start, then try out the rest service by clicking this link:

You can test the SOAP service using soapui. The wsdl location is http://localhost:8092/soap/touractivity?wsdl.Try sending this soap message:

      <ns:ota_touractivityavailrq target="Production" timestamp="2012-04-19T05:16:51.353Z" version="1.0" xmlns:ns="">
            <ns:basicinfo touractivityid="CITYSS">
               <ns:starttime gt="" lt="" ns:starttime="">
            <ns:participantcount quantity="1">

Your response should look something like this:



jliakos said...

I am trying to run your example but i get an error in the pom file

Artifactid is missing groupid is missing!

jliakos said...

I am trying to run your example but i get an error in the pom file

Artifactid is missing groupid is missing!

Fabio said...

I followed your template, but I received some errors in pom.xml

[ERROR] The project (C:\Users\Simo\workspace\popo\pom.xml) has 3 errors
[ERROR] Malformed POM C:\Users\Simo\workspace\popo\pom.xml: Unrecognised tag: 'groupid' (position: START_TAG seen ...\r\n ... @5:16) @ C:\Users\Simo\workspace\popo\pom.xml, line 5, column 16 -> [Help 2]
[ERROR] 'parent.groupId' is missing. @ line 4, column 12
[ERROR] 'parent.artifactId' is missing. @ line 4, column 12

The pom.xml file is:



JiBX opentravel touractivity web service implementation





Do you know the reason?!!
Thanks Fabio

Fabio said...
This comment has been removed by the author.
Unknown said...

Images and coding are very useful to understand this application features. Through this page, I learn the whole process which author describe.
web applications development US

Unknown said...

Thank you for your post. This was really an appreciating one. You did a good job. Keep on blogging like this unique information with us.
SAS Training in Chennai| SAS Course in Chennai

prethikarajesh said...

This information is impressive..I am inspired with your post writing style & how continuously you describe this topic. After reading your post,thanks for taking the time to discuss this, I feelhappy about it and I love learning more about this topic
digital marketing company in chennai

Unknown said...

I have own car so now I am back out there trying to show him how to do car repairs. Your blog is an excellent source of info, thanks.

House Cleaning Services in Mumbai
Car Wash Services in Mumbai

Unknown said...

This is very informative blog and nice article , I really like your technique of writing a blog. More screenshots gives the clear representation.. I book marked it to my bookmark site list and will be checking back in the near future Best Selenium Training in Velachery gives you the entire stuff about all the Selenium Components.

Unknown said...

Nice article . Thank you for this beautiful content, Keep it up. Techavera is the best Institute in Noida for all these main Courses below:-
Python training center in noida
SAP HANA Training in Noida.
Angular JS Training in Noida.
PLC SCADA Training in Noida.
Embedded Systems training in noida
Tally ERP 9 Training Institute in Noida.
java training center in noida

Visit us For Quality Learning.Thank you

pixel studios said...

Great post. I really impressive and informative. Thank you for your wonderful sharing.
Best Digital Marketing Company In Chennai
Digital Marketing Services In Chennai

Farhan.Jee said...

Following are the posts available for marketing graduates with specialization in digital marketing: data science course syllabus

Ashok said...

Truly, this article is really one of the very best in the history of articles. I am a antique ’Article’ collector and I sometimes read some new articles if I find them interesting. And I found this one pretty fascinating and it should go into my collection. Very good work!
data science course in India

Ashok said...

Really nice and interesting post. I was looking for this kind of information and enjoyed reading this one. Keep posting. Thanks for sharing.
Artificial Intelligence Course

arshiya said...

This is good information and really helpful for the people who need information about this.
devops skills
career objective
tableau course duration
how to improve spoken english
blue prism interview questions
blue prism interview questions and answers
javascript interview questions