genOSLC Integration Components

Owned by Edward Gentry
Last updated: Mar 07, 2023
2 min read

The following illustrates the basic components of a genOSLC integration.

genOSLC Integration Components

genOSLC consists of two components (blue above):

  1. 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.

  2. 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.

  • The Authoring Tool implements a Resource Preview for their resources.

 

Â