Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following illustrates the basic components of a genOSLC integration.

...

...

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 Tool Integration may communicate . The illustration above lists this as a REST interface, as this is currently most common, but REST is not strickly required(Native API above).

  • The Authoring Tool is capible capable of hosting the genOSLC plugin. In a standard web application this the genOSLC plugin is done hosted in an HTML iframe element. In programatic programmatic clients, like Eclipse, this is often acheived achieved with an embedded browser.

  • The Authoring Tool Native UI is capible capable of communicating with the genOSLC Plugin. This is normally done with JavaScript postMessage in the browser.

genOSLC

...

genOSLC consists of two components:

  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 Server: 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.