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
Mediator GE Open RESTful API Specification (PRELIMINARY) - FIWARE Forge Wiki

Mediator GE Open RESTful API Specification (PRELIMINARY)

From FIWARE Forge Wiki

Jump to: navigation, search

Contents

Introduction to the Mediator API

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

Mediator API Core

The Mediator API is a RESTful, resource-oriented API accessed via HTTP that uses XML representation for information interchange.

Mediator APIs allow to create and handle mediationServices i.e. services that can be invoked to call a target service adding specific mediation logics to the existing target service basic interface and behaviour. For more details about the Mediator GE, please refer to Mediator GE Open Specification.

The mediator APIs are meant to expose a common interface for different mediator implementations. These APIs provide resources and operations that allow to create mediation services that are able to use the specific mediation tasks provided by the mediator implementations. These APIs don't fully specify the mediator tasks themselves to avoid any constraint into possible mediator implementation capabilities.
Mediator APIs are not provided in the current version of the Mediator GE. A reference implementation of these APIs , will be provided in the final release of the Mediator GE.

Intended Audience

This specification is intended for both software developers and reimplementers of the Mediator GE. For the former, this document provides a full specification of how to interoperate with products that implement the Mediator APIs. For the latter, this specification indicates the interface to be implemented and provided to clients.

To use this information, the reader should firstly have a general understanding of the Mediator Generic Enabler. You should also be familiar with:

  • RESTful web services
  • HTTP/1.1
  • W3C WS-*
  • XML data serialization format

API Change History

This version of the Mediator API Guide replaces and obsoletes all previous versions. The most recent changes are described in the table below:

Revision Date Changes Summary Users
Apr 30, 2012
  • Initial version
TI
Jul 05 05, 2012
  • Dynamic mediation tasks
THALES
Sept 05, 2012
  • Update Template
TI
Oct 29, 2012
  • Updated Data Model Specification
TI THALES

How to Read This Document

It is assumed that the reader is familiar with the REST architecture style. Within 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 code or logical entities, e.g.
 HTTP method (GET, PUT, POST, DELETE)
  • An italic font is used to represent document titles or some other kind of special text, e.g.
URI
  • Variables are represented between brackets and in italic font, e.g.
{id}

The reader can replace the {id} with an appropriate value.

For a description of some terms used within this document, refer to the Mediator GE Open Specification.

Additional Resources

For more details about the Mediator GE that this API is based upon, please refer to Mediator GE Open Specification.

General Mediator API Information

Resources Summary

The mediator is structured into mediationServices and mediationTasks (mediationTasks type can also be dynamic mediation tasks).

Figure 2.1 Resources

Authentication

Each HTTP request against the Mediator GE requires the inclusion of specific authentication credentials. The specific implementation of this API may support multiple authentication schemes (OAuth, Basic Auth, Token) and will be determined by the specific provider that implements the GE. Please contact them to determine the best way to authenticate against this API. Remember that some authentication schemes may require that the API operate using SSL over HTTP (HTTPS).

Representation Format

The Mediator API supports XML for delivering metadata resources. The request format is specified using the Content-Type header and is required for operations that have a request body. The response format can be specified in requests using the Accept header (application/xml).


The interfaces should support data exchange through XML format:

  • application/xml - A XML description of the input and output.


Representation Transport

Resource representation is transmitted between client and server by using the HTTP 1.1 protocol, as defined by IETF RFC-2616. Each time an HTTP request contains payload, a Content-Type header shall be used to specify the MIME type of wrapped representation. In addition, both client and server may use as many HTTP headers as they consider necessary.

Resource Identification

In order to identify unambiguously the resources for HTTP transport is used the mechanisms described by HTTP protocol specification as defined by IETF RFC-2616.

Links and References

Web citizen

The mediator is relying on Web principles:

  • URI to identify resources
  • consistent URI structure based on REST style protocol

Paginated Collections

Mediator API will not limit the number of elements to return, because mediation service creation and handling doesn't require the exchange of very big data.

API Operations

Managing MediationServices

MediationServices Operations

Operations on the MediationServices resource:

Verb URI Name Description
GET /MediationServices getMediationServices Get the list of available mediationServices
GET /MediationServices/{mediationServiceID} getMediationService Get the mediationService by ID
PUT /MediationServices/{mediationServiceID} createOrUpdateMediationService Create or update a mediationService
DELETE /MediationServices/{mediationServiceID} deleteMediationService Delete the mediationService


Error Codes

200 OK

The request was handled successfully and transmitted in response message.

201 Created

The request has been fulfilled and resulted in a new resource being created.

204 No Content

The server successfully processed the request, but is not returning any content.

304 Not Modified

Indicates the resource has not been modified since last requested. Typically, the HTTP client provides a header like the If-Modified-Since header to provide a time against which to compare. Using this saves bandwidth and reprocessing on both the server and client, as only the header data must be sent and received in comparison to the entirety of the page being re-processed by the server, then sent again using more bandwidth of the server and client.

400 Bad Request

The request cannot be fulfilled due to bad syntax.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

409 Conflict

Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.

500 Internal Server Error

A generic error message, given when no more specific message is suitable.

Managing MediationTasks and DynamicMediationTasks

MediationTasks and DynamicMediationTasks Operations

Verb URI Name Description
GET /MediationTasks/ getMediationTasks Get the list of available mediationTasks
GET /DynamicMediationTasks/ getDynamicMediationTasks Get the list of available DynamicMediationTasks
GET /MediationTasks/{mediationTaskID} getMediationTask Get the mediationTask by ID
GET /DynamicMediationTasks/{dynamicMediationTaskID} getDynamicMediationTask Get the DynamicMediationTask
GET /MediationServices/{mediationServiceID}/MediationTasks getMediationTasksForMediationService Get the list of mediationTasks and DynamicMediationTasks set on the mediationService

Error Codes

200 OK

The request was handled successfully and transmitted in response message.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

The request cannot be fulfilled due to bad syntax.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

500 Internal Server Error

A generic error message, given when no more specific message is suitable.


Resources and Operations Details

Resources

The mediator GE offers a set of available mediation tasks: the set of mediation capabilities provided by the specific implementations.

The mediator GE allows users to create and manage their mediation services: a mediation service is a virtual proxy towards a web service that executes a chain of mediation tasks between the caller and the target service. The mediation task must be choosen from the set of available mediation tasks.

Mediation Task

Every available mediation task is identified by a Mediation task id. This identifier is used to specify this mediation task in every usage; it will be used in the creation of a mediation service to configure this mediation task in the mediation task chain that will be executed by the mediation service.

Every mediation task may have task-specific properties.

Mediation task capabilities will be added to the Mediator GE on the basis of FI-WARE needs.

Mediation Service

A mediation service is identified by a Mediation service name.

Every mediation service is configured with a chain of Mediation tasks: it is the mediation task chain that the mediation service will execute between the caller and the service.

The Mediation service URL is the URL that allows the invocation of the target service with the mediation of the mediation task configured to be executed by the mediation service.

To configure the mediation service the Target service endpoint must be specified: it is the URL of the target web service that will be invoked via the mediation service.

Mediation service additional settings can be configured too (e.g. Timeout).

Operations

createOrUpdateMediationService

This interaction allows to create a new mediation service (virtual proxy) to a web service or to update an existing mediation service, configuring the chain of mediation tasks that will be executed when the mediation service is invoked. The chain of mediation tasks will be executed between the caller and the target service.

Returns the URL that allows the invocation of the target service with the specified mediation, i.e. the mediation service URL.

The APIs allow to obtain the list of the available mediation tasks, in order to choose the mediation tasks that will be executed by the mediation service (see the getMediationTasks operation). An example of mediation task is the SOAP_TO_REST task that converts SOAP invocations into REST invocation.


Input Parameters

  • Mediation service name - Identification name for the mediation service. If no mediation service with the specified name exists, creates a new mediation service, identified by this name. If the specified name identify an existing mediation service then the invocation updates that mediation service according to the input data.
  • Target service endpoint - Target service URL i.e. URL of the service that will be invoked via the mediation service.
  • Mediation service additional parameters - mediation service additional settings (e.g. Timeout).
  • Mediation task list - The mediation task list that the mediation service will execute between the caller and the service. For every mediation task the following parameters must be specified:
    • Mediation task id - The task identifier (e.g. SOAP_TO_REST is the id of the mediation task that converts SOAP invocations into REST invocation). The list of available tasks, and the id of each of them, can be retrieved via the getMediationTasks operation.
    • Task-specific parameters - The parameter list of the specific task. For every parameter must be specified the identification name of the task parameter and the value of the parameter in the mediation service configuration.


Output Parameters

  • Mediation service URL - The URL that will be returned: it is the URL that allows service invocation with the specified mediation, i.e. the mediation service URL.


deleteMediationService

This interaction allows to delete a mediation service.


Input Parameters

  • Mediation service name - Identification name of the mediation service to delete.


getMediationService

This interaction allows to obtain the configuration of an existing mediation service.


Input Parameters

  • Mediation service name - Identification name of the mediation service whose configuration we are asking for.


Output Parameters

  • Target service endpoint - Target service URL i.e. URL of the service that will be invoked via the mediation service.
  • Mediation service additional parameters - mediation service additional settings (e.g. Timeout).
  • Mediation task list - The mediation task list that the mediation service will execute between the caller and the service. For every mediation task the following parameters are specified:
    • Mediation task id - The task identifier (e.g. SOAP_TO_REST is the id of the mediation task that converts SOAP invocations into REST invocation). The list of available tasks, and the id of each of them, can be retrieved via the getMediationTasks operation.
    • Mediation task description - The description of the Mediation task.
    • Task-specific parameters - The parameter list of the specific task. For every parameter is specified the identification name of the task parameter and the value of the parameter in the mediation service configuration.
  • Mediation service URL - the URL that allows service invocation with the specified mediation, i.e. the mediation service URL.


getMediationServices

This interaction allows to obtain the configured mediation services, as a list of their identification names.


Input Parameters
None


Output Parameters

  • Mediation service list - The list of mediation services configured on the Mediator. For every configured mediation service is returned its Mediation service name: the identification name of the mediation service, and the URL of the resource: the URL of the getMediationService operation for the specific mediation service


getMediationTasks

Returns the list of available mediation tasks that can be used to configure a mediation service. The mediation task is a basic mediation capability. When the mediation service is invoked, a list of mediation task will be executed (by the mediation service) between the caller and the target service.

Input Parameters
None


Output Parameters

  • Mediation task list - The list of available mediation task that is returned. For every available mediation task is returned its Mediation task id, a Mediation task description and the URL of the resource: the URL of the getMediationTask operation for the specific mediation task. The Mediation task id is the identifier that will be used to specify this mediation task in every usage (e.g. it will be used in the createOrUpdateMediationService operation to configure this mediation task as the one that will be executed by the mediation service)


getMediationTasksForMediationService

Returns the list of mediationTasks and DynamicMediationTasks set on the specified mediationService

Input Parameters
The Mediation service name, the identification name of the mediation service whose tasks we want to obtain.


Output Parameters

  • Mediation task list - The list of mediationTasks and DynamicMediationTasks set on the specified mediationService. For every mediation task is returned its Mediation task id, a Mediation task description and the URL of the resource: the URL of the getMediationTask operation for the specific mediation task..


getMediationTask

Get the configuration of the mediationTask identified by the specified Mediation task id

Input Parameters

  • Mediation task id - The id of the mediation task whose configuration we want to obtain.

The Mediation task id is the identifier that will be used to specify this mediation task in every usage (e.g. it will be used in the createOrUpdateMediationService operation to configure this mediation task as the one that will be executed by the mediation service)


Output Parameters

  • Mediation task id - The task identifier.
  • Mediation task description - The description of the Mediation task.
  • Task-specific parameters - The parameter list of the specific task. For every parameter is specified the identification name of the parameter and the default value of the task parameter, if the parameter has a default value


Dynamic mediation tasks details

The getDynamicMediationTasks and getDynamicMediationTask provide the same information as getMediationTasks and getMediationTask. Here we define more specifically the RESTfull API for these dynamic operations.

User who wants to use these operations must send http request towards their url resources :

Example of HTTP request
GET /DynamicMediationTasks HTTP/1.1
Host: example.org

OR

GET /DynamicMediationTasks/{dynamicMediationTaskID} HTTP/1.1
Host: example.org


getDynamicMediationTasks

The mediator HTTP response for this operation follows the XSD file reproduced here:

<?xml version="1.0" encoding="UTF-8"?><br \>
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.fiware.thalesgroup.com/DynamicMediationTasks" xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks" elementFormDefault="unqualified"><br \>
    <element name="DynamicMediationTasks">
        <complexType>
            <sequence>
                <element name="linkrel" type="string" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>Relative location of the operation url that retrieve dynamic mediation tasks.</documentation>
                    </annotation>
                </element>
                <element name="linkhref" type="string" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>Location in full http form of the operation url that retrieve dynamic mediation tasks.</documentation>
                    </annotation>
                </element>
                <element name="listDynamicMediationTasks" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>Listing of all dynamic mediation tasks.</documentation>
                    </annotation>
                    <complexType>
                        <sequence>
                            <element name="DynamicMediationTask" minOccurs="0" maxOccurs="unbounded">
                                <complexType>
                                    <sequence>
                                        <element name="id" type="string" minOccurs="1" maxOccurs="1">
                                            <annotation>
                                                <documentation>Id of the dynamic mediation tasks : {dynamicMediationTaskID}</documentation>
                                            </annotation>
                                        </element>
                                        <element name="linkrel" type="string" minOccurs="1" maxOccurs="1">
                                            <annotation>
                                                <documentation>relative location of this dynamic mediation task resource</documentation>
                                            </annotation>
                                        </element>
                                        <element name="linkhref" type="string" minOccurs="1" maxOccurs="1">
                                            <annotation>
                                                <documentation>Location in full http form of this dynamic mediation task</documentation>
                                            </annotation>
                                        </element>
                                        <element name="description" type="string" minOccurs="1" maxOccurs="1">
                                            <annotation>
                                                <documentation>Description of the dynamic mediation task.</documentation>
                                            </annotation>
                                        </element>
                                    </sequence>
                                </complexType>
                            </element>
                        </sequence>
                    </complexType>
                </element>
            </sequence>
        </complexType>
    </element>
</schema>


Example of HTTP response
HTTP/1.1 200 OK
Date: ...
Content-Type: application/xml; charset=utf-8
Content-Length: nnn
Last-Modified: Sat, 12 Aug 2006 13:40:03 GMT

<?xml version="1.0" encoding="UTF-8"?><br \>
<tns:DynamicMediationTasks
    xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.fiware.thalesgroup.com/DynamicMediationTasks DynamicMediationTasks.xsd "><br \>
    <linkrel>/DynamicMediationTasks</linkrel>
    <linkhref>http://example.org/DynamicMediationTasks</linkhref>
    <listDynamicMediationTasks>
        <DynamicMediationTask>
            <id>{dynamicMediationTaskID}</id>
            <linkrel>/DynamicMediationTasks/{dynamicMediationTaskID}</linkrel>
            <linkhref>"http://example.org/DynamicMediationTasks/{dynamicMediationTaskID}</linkhref>
            <description>description</description>
        </DynamicMediationTask>
    </listDynamicMediationTasks>
</tns:DynamicMediationTasks>

getDynamicMediationTask

The mediator HTTP response for this operation follows the XSD file reproduced here:

<?xml version="1.0" encoding="UTF-8"?><br \>
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.fiware.thalesgroup.com/DynamicMediationTasks" xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks" elementFormDefault="unqualified"><br \>
    <element name="DynamicMediationTask">
        <complexType>
            <sequence>
                <element name="id" type="string" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>Id of the dynamic mediation tasks : {dynamicMediationTaskID}</documentation>
                    </annotation>
                </element>
                <element name="linkrel" type="string" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>relative location of this dynamic mediation task resource</documentation>
                    </annotation>
                </element>
                <element name="linkhref" type="string" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>Location in full http form of this dynamic mediation task</documentation>
                    </annotation>
                </element>
                <element name="description" type="string" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>Description of the dynamic mediation task.</documentation>
                    </annotation>
                </element>
                <element name="specficParameters" minOccurs="1" maxOccurs="1">
                    <annotation>
                        <documentation>The parameter list of the specific task. For every parameter is specified the identification name<br \> of the parameter and the default value of the task parameter, if the parameter has a default value.</documentation>
                    </annotation>
                    <complexType>
                        <sequence>
                            <element name="parameter" minOccurs="0" maxOccurs="unbounded">
                                <complexType>
                                    <sequence>
                                        <element name="name" type="string">
                                            <annotation>
                                                <documentation>Name of the parameter.</documentation>
                                            </annotation>
                                        </element>
                                        <element name="description" type="string">
                                            <annotation>
                                                <documentation>Desciprtion of the parameter.</documentation>
                                            </annotation>
                                        </element>
                                        <element name="defaultValue" type="string" minOccurs="0" maxOccurs="1">
                                            <annotation>
                                                <documentation>The parameter can have a default value.</documentation>
                                            </annotation>
                                        </element>
                                        <element name="cardinality" minOccurs="0" maxOccurs="1">
                                            <annotation>
                                                <documentation>Cardinality specifies the number of repetitions of this parameter (defines array).<br \>OPTIONAL signifies the parameter can be omittedl. UNBOUNDED signifies that this parameter can be repeated infinitely.</documentation>
                                            </annotation>
                                            <simpleType>
                                                <restriction base="string">
                                                    <enumeration value="UNBOUNDED">
                                                    </enumeration>
                                                    <enumeration value="OPTIONAL">
                                                    </enumeration>
                                                </restriction>
                                            </simpleType>
                                        </element>
                                    </sequence>
                                </complexType>
                            </element>
                        </sequence>
                    </complexType>
                </element>
            </sequence>
        </complexType>
    </element>
</schema>

Example of HTTP response
HTTP/1.1 200 OK
Date: ...
Content-Type: application/xml; charset=utf-8
Content-Length: nnn
Last-Modified: Sat, 12 Aug 2006 13:40:03 GMT

<?xml version="1.0" encoding="UTF-8"?><br \>
<tns:DynamicMediationTask
    xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.fiware.thalesgroup.com/DynamicMediationTasks DynamicMediationTasks.xsd "><br \>
    <id>{dynamicMediationTaskID}</id>
    <linkrel>/DynamicMediationTasks/{dynamicMediationTaskID}</linkrel>
    <linkhref>http://example.org/DynamicMediationTasks/{dynamicMediationTaskID}</linkhref>
    <description>description</description>
    <specficParameters>
        <parameter>
            <name>name</name>
            <description>description</description>
            <defaultValue>defaultValue</defaultValue>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
    </specficParameters>
</tns:DynamicMediationTask>

Listing of all dynamic mediation tasks

Verb URI
GET /DynamicMediationTasks/BUILD_PAYLOAD_NOOP_WITH_PARAMS
GET /DynamicMediationTasks/BUILD_PAYLOAD_NOOP_WITH_SAXSD
GET /DynamicMediationTasks/DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_PARAMS
GET /DynamicMediationTasks/DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_SAXSD


ID:BUILD_PAYLOAD_NOOP_WITH_PARAMS

<?xml version="1.0" encoding="UTF-8"?><br \>
<tns:DynamicMediationTask xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.fiware.thalesgroup.com/DynamicMediationTasks DynamicMediationTasks.xsd "><br \>
    <id>BUILD_PAYLOAD_NOOP_WITH_PARAMS</id>
    <linkrel>/DynamicMediationTasks/BUILD_PAYLOAD_NOOP_WITH_PARAMS</linkrel>
    <linkhref>http://example.org/DynamicMediationTasks/BUILD_PAYLOAD_NOOP_WITH_PARAMS</linkhref>
    <description>This method allows to build dynamically the payload to send to an identified service. taken as input a list a value and<br \> the semantic operation that the client provide. The data given will be transformed into the service payload.</description>
    <specficParameters>
        <parameter>
            <name>usdUri</name>
            <description>The target service URL of the file descriptor in USDL format with references towards a sawsdl semantic<br \> definition</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
        <parameter>
            <name>usdUri</name>
            <description>The service id inside the USDL file. Need this id if the USDL reference more than one service.</description>
        </parameter>
        <parameter>
            <name>operationConcept</name>
            <description>The client need to access a certain operation of the service. In the case the client does not know the service<br \> operation syntactic name, he provides the semantic version of this operation.</description>
        </parameter>
        <parameter>
            <name>semanticInput</name>
            <description>The client has to give the list of parameter he wants to send to the service. The payload will be created <br \>based on these information.The parameter value must be given with the semantic description of the parameter.</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
    </specficParameters>
</tns:DynamicMediationTask>

ID:BUILD_PAYLOAD_NOOP_WITH_SAXSD

<?xml version="1.0" encoding="UTF-8"?><br \>
<tns:DynamicMediationTask xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.fiware.thalesgroup.com/DynamicMediationTasks DynamicMediationTasks.xsd "><br \>
    <id>BUILD_PAYLOAD_NOOP_WITH_SAXSD</id>
    <linkrel>/DynamicMediationTasks/BUILD_PAYLOAD_NOOP_WITH_SAXSD</linkrel>
    <linkhref>http://example.org/DynamicMediationTasks/BUILD_PAYLOAD_NOOP_WITH_SAXSD</linkhref>
    <description>This method allows to build dynamically the payload to send to an identified service. taken as input the client payload<br \> to transform with itssemantic description.</description>
    <specficParameters>
        <parameter>
            <name>usdUri</name>
            <description>The target service URL of the file descriptor in USDL format with references towards a sawsdl semantic<br \> definition</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
        <parameter>
            <name>usdUri</name>
            <description>The service id inside the USDL file. Need this id if the USDL reference more than one service.</description>
        </parameter>
        <parameter>
            <name>operationConcept</name>
            <description>The client need to access a certain operation of the service. In the case the client does not know the service<br \> operation syntactic name,he provides the semantic version of this operation.</description>
        </parameter>
        <parameter>
            <name>saxsd_content</name>
            <description>The client must give the SAXSD description of the data (payload) he wants to transforms (content or url). <br \>He gives here the value of the SAXSD.</description>
        </parameter>
        <parameter>
            <name>saxsd_url</name>
            <description>The client must give the SAXSD description of the data he wants to transforms (content or url).He gives here <br \>the url towards the accessible SAXSD resource.</description>
        </parameter>
        <parameter>
            <name>payload</name>
            <description>The client must gives the data he wants to transform. He gives here the value of the payload he sends.</description>
        </parameter>
    </specficParameters>
</tns:DynamicMediationTask>

ID:DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_PARAMS

<?xml version="1.0" encoding="UTF-8"?><br \>
<tns:DynamicMediationTask xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.fiware.thalesgroup.com/DynamicMediationTasks DynamicMediationTasks.xsd "><br \>
    <id>DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_PARAMS</id>
    <linkrel>/DynamicMediationTasks/DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_PARAMS</linkrel>
    <linkhref>http://example.org/DynamicMediationTasks/DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_PARAMS</linkhref>
    <description>This method allows to search and invoke a service capability with the given operation concept. After the invocation <br \>the result is adapted to he given wanted output.</description>
    <specficParameters>
        <parameter>
            <name>usdUri</name>
            <description>The target service URL of the file descriptor in USDL format with references towards a sawsdl <br \>semantic definition</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
        <parameter>
            <name>usdUri</name>
            <description>The service id inside the USDL file. Need this id if the USDL reference more than one service.</description>
        </parameter>
        <parameter>
            <name>operationConcept</name>
            <description>The client need to access a certain operation of the service. In the case the client does not know the<br \> service operation syntactic name, he provides the semantic version of this operation.</description>
        </parameter>
        <parameter>
            <name>semanticInput</name>
            <description>The client has to give the list of parameter he wants to send to the service. The payload will be created based<br \> on these information. The parameter value must be given with the semantic description of the parameter.</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
        <parameter>
            <name>semanticOuput</name>
            <description>The client has to give the list of parameter he wants to receive from the service. The parameter value must<br \> be given with the semantic description of the parameter.</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
    </specficParameters>
</tns:DynamicMediationTask>

ID:DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_SAXSD

<?xml version="1.0" encoding="UTF-8"?><br \>
<tns:DynamicMediationTask  xmlns:tns="http://www.fiware.thalesgroup.com/DynamicMediationTasks" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.fiware.thalesgroup.com/DynamicMediationTasks DynamicMediationTasks.xsd "><br \>
    <id>DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_SAXSD</id>
    <linkrel>/DynamicMediationTasks/DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_SAXSD</linkrel>
    <linkhref>http://example.org/DynamicMediationTasks/DATA_MEDIATION_AND_INVOCATION_NOOP_WITH_SAXSD</linkhref>
    <description>This method allows to search and invoke a service capability with the given operation concept. After the <br \>invocation the result is adapted to the given wanted output.</description>
    <specficParameters>
        <parameter>
            <name>usdUri</name>
            <description>The target service URL of the file descriptor in USDL format with references towards a sawsdl <br \>semantic definition</description>
            <cardinality>UNBOUNDED</cardinality>
        </parameter>
        <parameter>
            <name>usdUri</name>
            <description>The service id inside the USDL file. Need this id if the USDL reference more than one service.</description>
        </parameter>
        <parameter>
            <name>operationConcept</name>
            <description>The client need to access a certain operation of the service. In the case the client does not know<br \> the service operation syntactic name, he provides the semantic version of this operation.</description>
        </parameter>
        <parameter>
            <name>saxsd_content</name>
            <description>The client must give the SAXSD description of the data (payload) he wants to transforms (content or url)<br \> and the awaited response format.He gives here the value of the SAXSD.</description>
        </parameter>
        <parameter>
            <name>saxsd_url</name>
            <description>The client must give the SAXSD description of the data he wants to transforms (content or url) and <br \>the awaited response format. He gives here the url towards the accessible SAXSD resource.</description>
        </parameter>
        <parameter>
            <name>payload</name>
            <description>The client must gives the data he wants to transform. He gives here the value of the payload <br \>he sends.</description>
        </parameter>
        <parameter>
            <name>wanted_response_element</name>
            <description>The client gives here the element reference inside the SAXSD description resource that contains <br \>the description of the wanted response format.</description>
        </parameter>
    </specficParameters>
</tns:DynamicMediationTask>



Personal tools
Create a book