README.md

SignON Orchestrator

The SignON Orchestrator repository is part of SignON an EU H2020 research and innovation funded project.
The SignON Orchestrator manages and coordinates incoming requests from the SignON Mobile App and SignOn ML App, and it is responsible to interact internally with the SignON Pipeline.

In detail, the SignON Mobile App interfaces with the SignON Orchestrator using REST APIs (see SignON Orchestrator OpenAPI), while a message broker facilitates communication between the SignON Orchestrator and SignON Dispatchers.
The SignON Orchestrator activates the SignON Dispatchers, which in turn contact the object storage (if necessary) and the SignON Pipeline components responsible for the related processing based on the different input (text, audio, or video) and the requested output (text, audio, avatar).

For further details please refer to public deliverable D2.5 - Final release of the Open SignON Framework.

Getting Started

Prerequisites

• JAVA VM: OpenJDK 11
• Message Broker: RabbitMQ
• Object Storage: MinIO
• SignON Dispatchers:
  • SignON WP3 Dispatcher
  • SignON WP4 Dispatcher
  • SignON WP5 Dispatcher
• Server stub generator:
  • AsyncAPI Generator v1.8.27

    npm install -g @asyncapi/[email protected]
    

  • AsyncAPI Java Spring Template v0.18.3

    npm install -g @asyncapi/[email protected]
    

For further details about the configuration of the components please refer to SignON Framework Docker Compose.

Installation

• Clone this repository with recursive option:

  git clone --recursive [email protected]:signon-project/wp2-orchestrator.git
  

• Compile and generate code:

  mvn clean install
  

Usage

1. Configure the SignON Orchestrator (src/main/resources/application.yml)

2. Start the SignON Orchestrator

   docker build signon-orchestrator-X.X.X.jar
   /java -Dspring.config.location=/your/repo/path/config.yml -jar /your/repo/path/signon-orchestrator-X.X.X.jar 
   

   N.B. config.yml overwrites src/main/resources/application.yml.

3. Simulate SignON Mobile App requests with cURL
   Thanks to the REST APIs, it is possible to simulate the SignON Mobile App and SignOn ML App requests using the cURL command from a terminal (see Example Requests).

Additional information

Compatibility Matrix

signon-orchestrator	signon-orchestrator-openapi	signon-orchestrator-asyncapi
17.0	14.0	8.0
15.0	13.0	8.0
14.0	12.0	8.0
13.0	11.0	8.0
12.0	11.0	8.0
11.0	10.0	7.0
10.0	9.0	7.0
9.0	8.0	7.0
8.2	7.1	7.0
8.0	7.0	7.0
7.0	6.0	6.0
6.0	5.0	5.0
5.0	4.0	4.0
4.0	4.0	4.0
3.0	3.0	3.0
2.1	2.0	2.0
2.0	2.0	2.0
1.0	1.0	1.0
0.1	0.1	0.1

Documentation

The following technical documentation is available:

• SignON Orchestrator OpenAPI (link)
• Errors Documentation (link)

Other details

• IDE: Visual Studio Code
• The asyncapi_codegen.sh script is used by maven to generate the server stub from the AsyncAPI (see pom.xml)

Authors

This project was developed by FINCONS GROUP AG within the Horizon 2020 European project SignON under grant agreement no. 101017255.
For any further information, please send an email to [email protected].

License

This project is released under the Apache 2.0 license.