The following illustrates the basic components of a genOSLC integration.

genOSLC

genOSLC consists of two components (blue above):

genOSLC Java Framework This is a Spring Boot based framework delivered as a Java Jar file. The Authoring Tool Integration implements an IToolAdapter Java interface and the genOSLC framework exposes an OSLC API for the the Authoring Tool.
genOSLC Plugin : This is the server for the genOSLC plugin. It is delivered as a docker container. The plugin is integrated into the native UI of the Authoring Tool, which communicates with the genOSLC plugin notifying it of the selection of artifacts in the Authoring Tool. The genOSLC plugin enables display, creation and deletion of links to artifacts of the Authoring Tool.

Authoring Tool

The authoring tool (in green above), may be implemented in any technology. The following are general requirements of the Authoring tool Architecture.

The Authoring Tool has a web interface with which the Authoring Tool Integration may communicate (Native API above).
The Authoring Tool is capable of hosting the genOSLC plugin. In a web application the genOSLC plugin is hosted in an HTML iframe element. In programmatic clients, like Eclipse, this is often achieved with an embedded browser.
The Authoring Tool Native UI is capable of communicating with the genOSLC Plugin. This is normally done with JavaScript postMessage in the browser.

Doc in Smartfacts (will be moved):

Different images for different Authoring tools
Every genOSLC will contain the OSLC Framework and the specific code for the given tool
2 Containers
- one for Authoring tool
- one is genOSLC plugin
Tagging of Images
- Default is “latest”
- with PluginVersionOverride and “integrationVersionOverride” the Image tag can bei used
- Images has a naming convention: only the name of the authoring tool changes
  - sfit-oslc-generic-<authoring tool>
genOSLC v2 a separate helm chart. It is necessary to be able to reference it from the smartfacts helm chart.

→ End of May (CDCM is more important)