We use proprietary and third party's cookies to improve your experience and our services, identifying your Internet Browsing preferences on our website; develop analytic activities and display advertising based on your preferences. If you keep browsing, you accept its use. You can get more information on our Cookie Policy
Cookies Policy
Composition Engine Open API Specification (PRELIMINARY) - FIWARE Forge Wiki

Composition Engine Open API Specification (PRELIMINARY)

From FIWARE Forge Wiki

Jump to: navigation, search


Introduction to the Composition Engine API

Please check the FI-WARE Open Specifications Legal Notice to understand the rights to use FI-WARE Open Specifications.

Composition Engine API Core

The Composition Engine API core is a Java RMI API that exposes basic control functionality to an external controller. A composition editor is the right tool to provide a GUI that will allow the end user to control the Service Composition Engine.

Intended Audience

This specification is intended for developers of the composition editor. Here we describe how to import and export composed service (skeleton) descriptions in the Service Composition Engine and how to mark them for execution. To use this information, the reader should firstly have a general understanding of the Generic Enablers for Composition and Mashup. You should also be familiar with:

  • Java

API Change History

Revision Date Changes Summary
May 3, 2012
  • Initial version

How to Read This Document

In the whole document it is taken the assumption that reader is familiarized with Java. Along the document, some special notations are applied to differentiate some special words or concepts. The following list summarizes these special notations.

  • A bold, mono-spaced font is used to represent method names.
  • Function parameters are represented in italic font.

For a description of some terms used along this document, see Composition Execution engine .

Composition Engine API

String import(String skeletonDescription)

Imports the composite service (skeleton) description into the local description storage. Returns a handle that uniquely identifies this skeleton. If a skeleton with the same name is available in the local description storage its description will be updated. The file format of the composition depends on the underlying execution engine. In case of a BPEL engine the composition must comply to the WSBPEL standard (WSBPEL is standardized by OASIS https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsbpel).

  • skeletonDescription - The fully contained description of the composed service

String export(String skeletonId)

Exports the composite service (skeleton) description from the local description storage. Returns the fully contained description of the skeleton.

  • skeletonId - The handle that uniquely identifies the skeleton

void remove(String skeletonId)

Removes a skeleton from the local descriptions storage. Only disabled skeletons can be removed.

  • skeletonId - The handle that uniquely identifies the skeleton

void enable(String skeletonId)

Prepares a skeleton from the local descriptions storage for execution. It instantiates the composed application skeleton, exposes its interface and makes it ready to be triggered for execution. Only enabled skeletons will be considered during the skeleton execution. Note that by enabling a certain skeletons for execution, the engine automatically exposes the API of these compositions towards the external world, and any access to this API will trigger the execution of the respective skeleton. This is an API exposed by the execution engine, however it is created at runtime in the form specified by the composed service.

  • skeletonId - The handle that uniquely identifies the skeleton

void disable(String skeletonId)

This operation removes a skeleton from the executable list.

  • skeletonId - The handle that uniquely identifies the skeleton
Personal tools
Create a book