Log out?

RESTful Web Service Listener

This implementation of the RESTful Web Service Listener allows the end user to accept RESTful web service calls to any resource in the system in any possible machine-readable Format. The Listener is very flexible and configurable.

The following parameters can be configured:

There are 5 tabs: Basic, Advanced, Transaction Logging, Authentication and Supported HTTP Methods.

1.Basic: In this tab, you can specify:

REST Service name: part of the HTTP path to listen at – for example ‘http://server.com/service/{ServiceName}/Car/21’. Service name should not contain ‘/’.
Supported Resources: list of the supported resources names.
Timeout: specifies how long the Listener should wait for messages which are interrupted before timing out the connection.
WADL file: WADL file that would be returned on request that ends with “?wadl” .


2. Advanced: This tab allows us to set the following settings.

Initialize on trigger only: If enabled, the Listener doesn’t start up until a trigger initializes it.
Allow command-line invocation: If enabled, listener can be invoked using the CLI client application.
Restart on listening error: If enabled, listener will be restarted after error occurs.

FIFO Queue Name: The FIFO stuff enables a “First In, First Out” queuing mechanism between Listeners and Transports. If a “FIFO Queue Name” is provided, that name will be used as a key for a queue Transactions & will be pushed into before reaching a transport. They’ll be ordered in this queue according to when the Listener created them.

FIFO Queue Delay: It is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order the Listener created them in.

Require SSL: If selected, plain text requests will be rejected.
Synchronous: Specifies whether or not a response is expected. To set response headers, see “Synchronous Response Headers” section below.

HTTP Headers: Allows specification of HTTP header name-value pairs to use in synchronous response.


3. Transaction Logging – This tab allows us to enable transaction events logging. That data can be logged by a TransactionEventListener.

The Transaction Logging Enable checkbox allows transaction events originating from this listener to be logged by a TransactionEventListener.

Log Transaction Attribute – if enabled, logs transaction attributes.

Log Transaction Data – if enabled, logs transaction data body.

Log Transaction Data Base64 – if enabled, logs transaction data body as Base64.

4. Authentication: This tab allows you to set the following:

User Name: Enter user name(if necessary)
Password: Enter password (if necessary)


5.  Supported HTTP Methods – This tab allows you to set HTTP methods that would be used.


Synchronous Response Headers

You can specify synchronous response headers in a Map that you store in an attribute named com.pilotfish.eip.modules.http.StoredHeaders.  That can be done in a Transaction Attribute Population Processor.

1. Transaction Attribute Name: com.pilotfish.eip.modules.http.StoredHeaders

2. Evaluation Expression: {ognl:#map=new java.util.HashMap(),#map.put(‘Content-Type’,’application/json’),#map}

The above OGNL expression does the following:

  1. Creates a new HashMap and stores it in an OGNL variable called “map”
  2. Puts a name/value pair into the map for the Content-Type header.  (Repeat this statement to add additional headers.)
  3. Returns the map variable.


This is a unique website which will require a more modern browser to work! Please upgrade today!


Our editors are notified.