JOSIF Rel 1.0 Release Notes

Owned by Craig Gallen [Administrator] (Unlicensed)
Last updated: Dec 04, 2012Version comment
2 min read

JOSIF Main Page | JOSIF Rel 1.0 | JOSIF Rel 1.0 Release Notes

Overview

Joint Open Source Interface Framework (JOSIF) is an open source interface infrastructure that includes the definition of interface patterns and associated tooling. Starting with an information model, JOSIF automatically generates both XML and Java based interface specifications, and supporting documentation. This is a Model Driven Engineering (MDE) approach that helps to reduce cycle time, increase quality and maintain consistency between the model and the specification. It is based on the Tigerstripe tool, an eclipse incubation project. It uses stereotypes as model decorations to drive the tooling.

JOSIF Release 1.0 focuses on the generation of the specification aspect of an interface. Generation of the Reference Implementation (RI) and Compliance Test Kit (CTK) is only partial in this version and will be enhanced in future versions.

Changes in this release

This section describes the major changes in this release.

As this is the initial release of JOSIF, this section is left empty intentionally.

Release Features

The JOSIF Guidebook provides the documentation for modeling and building interfaces, as well as the documentation of the patterns used in JOSIF.

JOSIF is using the SID model as the data model for interface definition. The SID model relevant to the interface is imported to Tigerstripe where the operational model is added to build the system view of the interface.
JOSIF Rel. 1.0 provides the following Tigerstripe generators:

  • TIP_Doc_Generator: builds the Information Agreement (IA) document from the model and user-supplied files.
  • TIP_Soap_Generator: builds the SOAP (WSDL/XSD) interface specifications from the model.

JOSIF Rel. 1.0 also includes a generator to produce a Java interface which is used for the associated RI, but is not officially part of the interface specifications in this release. JOSIF Rel. 1.0 also includes draft generators for building the skeleton of the RI.

JOSIF Rel. 1.0 includes also a number of interface patterns used to provide consistent generation of interfaces. Those patterns are described in the General Patterns section of the guidebook:

  • Notifications
  • Exceptions and common exceptions
  • Iterator
  • Optional/mandatory
  • Extensibility

Release Definition

JOSIF Rel. 1.0 is not provided as an installable kit.

JOSIF uses a maven build environment to automate the generation of the interfaces, from the generation of the documentation up to the packaging of the interface. The maven build environment will download the generators and common model libraries needed for interface generation.

If participating in an existing interface project, please follow the steps defined in the Getting Started page to set up your environment from SVN.

When starting a new interface, please use the JOSIF Project Creator to automatically generate archetype maven projects for JOSIF implementors. The created projects will have the full build system set up to download the correct model dependencies and Tigerstripe dependencies (generators and profiles) from maven. No other download is needed.

The JOSIF Rel. 1.0 documentation is only provided online as wiki pages. Please refer to the JOSIF Main Page for complete JOSIF documentation.