The following illustrates the basic components of a genOSLC integrationJava Framework.
...
...
*he actual OSLC endpoints and functionality are ommited to focus on the 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 integration may communicate. The illustration above lists this as a REST interface, as this is currently most common, but REST is not strickly required.
The Authoring Tool is capible of hosting the genOSLC plugin. In a standard web application this is done in an HTML iframe element. In programatic clients, like Eclipse, this is often acheived with an embedded browser.
The Authoring Tool Native UI is capible of communicating with the genOSLC Plugin. This is normally done with JavaScript postMessage in the browser.
genOSLC
...
IToolAdapter Implementation
A genOSLC is a Spring Boot Java application which uses the genOSLC Java Framework. The heart of the integration is the implementation of the IToolAdapter Java interface (Authoring Tool Adapter above). This implementation uses the Native API of the Authoring Tool to expose its objects to genOSLC.
The IToolAdapter Interface uses Tool Adapter Objects (all with suffix Tao). The following are the primary Tool Adapter Objects each encapsulates an OSLC concept.
Tool Adapter Objects (TAOs)
The following are the primary Tool Adapter Objects
Java Class | Usage |
|---|---|
ServiceProviderTao | This models an OSLC Service Provider. It contains at least one ComponentTao. |
ComponentTao | This models an OSLC Component. The Component is the smallest object in OSLC container that may have versions and branches. It is contain in exactly one Service Provider. |
LocalConfigurationTao | This models an OSLC configuration. It is essentially either a branch or a baseline of the component. |
ArtifactTao | This models an OSLC resource e.g. a Test Case, Requirement, Architecture Element etc. Artifacts are owned by a single component. |
ResourceShapeTao | Models a resource shapes or scheme in OSLC. Resource shapes are owned by a single component. |
Application.YML
An Application.YML is a standard Spring Boot configuration file which is used to configure Spring Boot Applications.