PilotFish Interface Exchange (PIE)

A marketplace for eiConsole (IDE) interface templates, components and industry bundles
eiConsole IDE 90-Day Free Trial!
Associated Industry
Associated Application
The eiConsole IDE is highly recommended to support graphical development of interfaces for deployment to the eiPlatform runtime The eiPlatform is required to run in production interfaces configured using the eiConsole
Release Date
November 29, 2011
Resource Type
Custom Module Extension

Product details

RESTful Web Service Transport

The REST-style (Representational State Transfer) architecture is a popular approach of accessing and managing remote resources in the World Wide Web. It relies on a stateless, client-server, cacheable communications protocol - usually HTTP. The idea is that, rather than using complex mechanisms such as CORBA, RPC or SOAP to connect between machines, simple HTTP is used to make calls between machines. You can read more about the REST approach in the REST Tutorial blog or in the Wikipedia.

This implementation of the RESTful-style web service transport for XCS eiConsole allows users to:

  1. Define the HTTP method to perform on resource - GET, POST, PUT, DELETE or HEAD
  2. Compress request or request and response data using GZIP algorithm
  3. Specify acceptable media type (e.g. 'application/json')
  4. Specify query parameters key-value map
  5. Specify username and password for HTTP authentication
  6. Set the response listener

Below you can see the configuration panel of this Transport.

RESTful Transport Configuration Panel  

The RESTful Web Service Transport has been implemented using Open Source Jersey project (version 1.20). Thus, it requires the following libraries to be in the classpath of the XCS eiConsole and XCS eiPlatform:

  • jersey-client-1.10.jar
  • jersey-core-1.10.jar

You can download these file in the Documents section of this web page.

This module is open source you provided "AS IS", without warranty of any kind. You can use it and its code for any purposes. The source code of the module also can be downloaded in the Documents section of this page.

This module is provided with sample interface, that demonstrates how to work with it. This interface basically runs empty transactions every 20 seconds, fires request to the 'http://search.twitter.com/search.json' with query 'A2AIntegration' and puts data to the output directory. The sample working directory is attached to this product. You can download it from the Documents section on the right hand side.

Release Details

This is the initial release of the RESTful Web Service Transport.