JOSIF Main Page | Framework Guidebook
Contents
1 Introduction
2 Modeling
2.1 Service Design
2.2 Service Interfaces
2.3 Interface Meta-Model
2.3.1 Introduction
2.3.2 Information Modeling
2.3.3 Operational Modeling Operational Modeling
2.4 Interface Project vs Dependencies
2.5 General Patterns
2.5.1 Stereotypes
2.5.2 Interface Meta-Model
2.5.3 Model Transformation Rules
2.5.4 Entity Identifier
2.5.5 Extensibility
2.5.6 Exceptions
2.5.7 Interaction Patterns
2.5.8 Notifications
2.5.9 Common Operations
2.5.10 Filtering
2.6 General Patterns - Future
2.6.1 Versioning
2.6.2 Optionality
2.6.3 Value Representation
2.7 Shared Framework Model
2.7.1 Introduction
2.7.2 Common Framework Model
2.7.3 Internal Framework Model
3 Tooling
3.1 Principles
3.2 Information Model Tooling
3.3 Setting up the Interface Project
3.4 TIP Profile
3.5 Interface Design
3.5.1 Importing Information Model
3.5.2 Avoid not supported Tigerstripe features
3.5.3 Developing the Operational Model
3.5.4 Validating the Model
3.5.5 Adding needed files for the Specification
3.5.6 Generating the Specification
3.6 Interface Projects
4 Implementation
5 Framework Projects
Introduction
JOSIF (Joint Open Source Interface Framework) provides the environment, patterns, tooling and libraries needed to develop interfaces.
This guidebook explains how to use it.
The first chapter explains the modeling principles used in JOSIF, as well as the meta-model underneath it. The shared models used are part of this chapter.
The second chapter on tooling is moer targeting on how to use practically the tooling to build interfaces. e TIP Design Specifications call for the specification of coarse-grained interfaces to typical OSS applications such as trouble ticketing or inventory management. The interfaces are characterized by a well-defined set of managed-entity types which are exposed by one of the interfaces described in the TIDS protocol-specific Specification.
The third chapter will cover the implementation part, Reference Implementation (RI) and Conformance Test Kits (CTK). This chapter is empty as RI and CTK will be addressed in JOSIF V1.2.
The last chapter descrbed the various Frmework sub-projects.
Note: while JOSIF is developped in open source, this is no implied obligation that the interfaces developed using JOSIF are also developed in open source.
Modeling
Modeling Describes the modeling part of this guidebook
Tooling
Tooling Describes the tooling part of this guidebook
Implementation
Describes the implementation part of the gudiebook, Reference Implementation (RI) and Conformance Test Kits (CTK). This chapter is empty as RI and CTK will be addressed in JOSIF V1.2.
Framework Projects
TBD