CILIA API REST
Prerequisites
The Cilia API REST is based on Jersey. And uses RoSe to eases the usage. In order to export the API Rest it is needed to have the following bundles.
To easies the configuration and the dependencies, please download the cilia distribution containing the dependencies and the configuration files to have the remote service ready to use :
Manipulating a Chain
Method | PATH | PARAMETERS | DESCRIPTION | EXAMPLE (Using command line tool cURL) |
---|---|---|---|---|
GET | <HTTP_SERVER>/cilia | NONE | Get the list of chain ids. | curl -X GET http://localhost:8080/cilia |
GET | <HTTP_SERVER>/cilia/<CHAIN_ID> | NONE | Get the information of a mediation chain. | curl -X GET http://localhost:8080/cilia/HelloWorld |
POST | <HTTP_SERVER>/cilia/<CHAIN_ID> | NONE | Creates an empty chain. | curl -X POST http://localhost:8080/cilia/HelloWorld |
PUT | <HTTP_SERVER>/cilia/<CHAIN_ID>/components |
|
Copy the information of an existent component to another. | curl -X PUT -d "command=copy&from=m1&to=m2" http://localhost:8080/cilia/HelloWorld/components |
PUT | <HTTP_SERVER>/cilia/<CHAIN_ID>/components |
|
Replace one component for another and copy his data. | curl -X PUT -d "command=replace&from=m1&to=m2" http://localhost:8080/cilia/HelloWorld/components |
DELETE | <HTTP_SERVER>/cilia/<CHAIN_ID> | NONE | Delete a mediation chain | curl -X DELETE http://localhost:8080/cilia/HelloWorld |
Manipulating Components
Method | PATH | PARAMETERS | DESCRIPTION | EXAMPLE (Using command line tool cURL) |
---|---|---|---|---|
GET | <HTTP_SERVER>/cilia/<CHAIN_ID>/components/<ID> | NONE | Get the information of a component (mediator or adapter) | curl -X GET http://localhost:8080/cilia/HelloWorld/components/hello-mediator-1 |
GET | <HTTP_SERVER>/cilia/<CHAIN_ID>/mediators/<ID> | NONE | Get the information of a mediator | curl -X GET http://localhost:8080/cilia/HelloWorld/mediators/hello-mediator-1 |
GET | <HTTP_SERVER>/cilia/<CHAIN_ID>/adapters/<ID> | NONE | Get the information of an adapter | curl -X GET http://localhost:8080/cilia/HelloWorld/adapters/adapter1 |
POST | <HTTP_SERVER>/cilia/<CHAIN_ID>/mediator/<TYPE>/<ID> | properties=<Properties in JSON> | Creates a mediator component | curl -X POST -d "properties={name=titi}" http://localhost:8080/cilia/HelloWorld/mediator/HelloMediator/hello-mediator-1 |
POST | <HTTP_SERVER>/cilia/<CHAIN_ID>/adapter/<TYPE>/<ID> | properties=<Properties in JSON Format> | Creates an adapter component | curl -X POST -d "properties={namespace=titi}" http://localhost:8080/cilia/HelloWorld/adapter/ConsoleAdapter/console-adapter-1 |
PUT | <HTTP_SERVER>/cilia/<CHAIN_ID>/components/<ID> | properties=<Properties in JSON Format> | Modify the component properties | curl -X PUT -d "properties={prefix=Hi}" http://localhost:8080/cilia/HelloWorld/components/hello-mediator-1 |
DELETE | <HTTP_SERVER>/cilia/<CHAIN_ID>/components/<ID> | NONE | Remove a component in the given chain. | curl -X DELETE http://localhost:8080/cilia/HelloWorld/components/hello-mediator-1 |
DELETE | <HTTP_SERVER>/cilia/<CHAIN_ID>/mediators/<ID> | NONE | Remove a mediator in the given chain. | curl -X DELETE http://localhost:8080/cilia/HelloWorld/mediators/hello-mediator-1 |
DELETE | <HTTP_SERVER>/cilia/<CHAIN_ID>/adapters/<ID> | NONE | Remove an adapter in the given chain. | curl -X DELETE http://localhost:8080/cilia/HelloWorld/adapters/console-adapter-1 |
Manipulating Bindings
Method | PATH | PARAMETERS | DESCRIPTION | EXAMPLE (Using command line tool cURL) |
---|---|---|---|---|
POST | <HTTP_SERVER>/cilia/<CHAIN_ID>/bindings |
|
Perform a binding between two components. | curl -d "from=hello-mediator-1:unique&to=console-adapter-1:unique&linker=JMS_Joram&properties={jms.topic=wiki}" -X POST http://localhost:8080/cilia/HelloWorld/bindings |
DELETE | <HTTP_SERVER>/cilia/<CHAIN_ID>/bindings?from=<id:port>&to=<id:port> | NONE | Remove a binding between two components. | curl -X DELETE http://localhost:8080/cilia/HelloWorld/bindings?from=hello-mediator-1:unique&to=console-adapter-1:unique |