Building Snapshots

Owned by Craig Gallen [Administrator] (Unlicensed)
Last updated: Feb 07, 2013Version comment
3 min read

JOSIF Main Page | JOSIF Platform | Prototype CTK RI Project | Building Snapshots

Introduction

The following instructions are for checking out and building one of the RI or CTK snapshots. The page will be updated through each iteration.

Ceneral process for creating an RI /CTK project

In this description, the Interface Projects are the projects which are used to generate all of the interface and library artefacts from the models. The Interface Projects are all created using the Project Creator. Running an interface project will create the stubb code needed for libraries or for creating an RI and CTK. In principle the generated stubb code should not be manually modified or extended in the Interface Project. We need to create separate RI and CTK projects to use this stubb code.

In general the process for creating a working RI or CTK project is as follows;

1. Checkout all the models in an interface project as described in Getting_Started but substitute the branch your are working in for the name of the project. Each Interface Project has a number of modules and these all have to be built using maven to get the dependencies into your local maven (.m2) repository. We are not presently deploying any of the generated jars to a public repository.

2. To build the stubb RI / CTK code you must must uncomment all of the java modules in the <xxx>_BaseProject before you open a terminal and type 

mvn clean install

3. Copy and build the working RI or CTK projects

The interface Project only creates the skeleton of an RI and CTK. We need to create separate RI and CTK projects by cloning and renaming the <xxx>_CTKProject (CTK) and <xxx>_WSImpl projects. We will then manually add additional code into these clones to make the RI and CTK. (<xxx> is the name of the interface)

To be clear, WE DO NOT modify the projects used to create the stubb code. We copy them into a different branch and modify the copies.

After copying and renaming the RI /CTK project, we need to change the name of the project pom.xml files to match the name of each RI or CTK project. It should not be named the same as the <xxx>_CTKProject (CTK) or <xxx>_WSImpl projects. If you have built the Interface projects correctly, all of the dependencies will be in the local maven repository to all ow you to build your new copied projects.

You need to open a terminal the new copied projects and type 

mvn clean install

After that you need to type

mvn eclipse:eclipse.

This has described the general process we are following. We are creating branches for each iteration of the RI and CTK. The following sections describe where to check out these branches.

RAM CTK Snapshot 1

RI Location

The RAM RI we are presently hosting is under the following branch:

<RAM Repository>/Features/ResourceAlarmManagement/IA/Interface/branches/NotificationTests/TIP_RAM_WSNotificationProject

Pierre is adding new notification code on the next branch

<RAM Repository>/Features/ResourceAlarmManagement/IA/Interface/branches/NotificationTests2/TIP_RAM_WSNotificationProject

To run the RI follow the instructions in CTK Test Runner Requirements

CTK location

The CTK we are currently running is simply the generated CTK in the InterfaceProject . There is not a separate CTK project yet.

To run the CTK follow the instructions in RI Requirements

NOTE C Gallen as of 24/8/11 the RI and CTK builds with latest soap plugin

NOTE C Gallen as of 17/8/11 the RI and CTK only build correctly when using the snapshot soap plugin before Pierre's changes to the anonymous classes. This plugin is available at the following subversion branch: https://openoss.svn.sourceforge.net/svnroot/openoss/tip/framework/TIP_Soap_Generator/branches/Rev3016-SNAPSHOT