Lyo/TRSSDK

The Tracked Resource Set (TRS) Software Development Kit (SDK) consists of two primary pieces; a toolkit and reference applications.

TRS Toolkit

The goal of the TRS toolkit is to provide a simple set of java beans that represent the entities within the TRS specification. Additionally, a convenient set of string constants that represent the TRS properties is provided.

Loading the TRS Toolkit

Prerequisites

• Eclipse 3.6 or higher IDE
• EGit team provider for git (recommended) or git command line package.
• m2eclipse for Maven support in the Eclipse IDE
• Lyo client requires a Java 1.6 compiler and Java 1.6 runtime. The Eclipse project settings have been set appropriately. If you are building outside of Eclipse, please use Java 1.6.

Clone the Lyo Core git repository

This example assumes EGit is being used.

• Open the Git Repositories view in Eclipse and click the Clone Git Repository icon
• Use git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.core.git as the URI (browse it also on line). User/Password are not required.
• On the Branch Selection page, select the master branch
• On the Local Destination page, specify a location or accept the default and click Finish

The repository should now show up in your Git Repositories view.

Import Eclipse projects from the git repository

• In the Git Repositories view, right click org.eclipse.lyo.core and select Import Projects
• Select the Import Existing Projects wizard and click Next
• Import the following projects:

   OSLC4J

   OSLC4JJenaProvider

   OSLC4JJson4JProvider

   OSLC4JWink

   org.eclipse.lyo.core.utils

   org.eclipse.lyo.core.trs

You may import the other projects if you like, but they are not required for building the TRS Toolkit.

[Optional] Add the projects to a new working set.

Build all projects

• Expand the OSLC4J project
• Right click pom.xml -> Run As -> Maven clean
• Right click pom.xml -> Run As -> Maven install
• Repeat these steps for the following projects in the listed order:

    OSLC4JJenaProvider
    OSLC4JJson4JProvider
    OSLC4JWink
    org.eclipse.lyo.core.utils
    org.eclipse.lyo.core.trs

Exploring the TRS Toolkit

The goal of the TRS toolkit is to provide an inclusive library stack for adopting TRS. This framework will provide the ability for:

• Generating the TRS services via JAX-RS using Apache Wink
• (De)Serialization of the TRS Beans through OSLC4J

In addition to the framework provided by OSLC4J the TRS toolkit consists of a set of Java beans that may be used with or without the provided framework.

Beans

• TrackedResourceSet
• Base
• AbstractChangeLog
• ChangeLog
• EmptyChangeLog
• ChangeEvent
• Creation
• Modification
• Deletion
  

TRS Reference Application

Before following the steps in this section please make sure the TRS Toolkit from section 1 has been loaded into your workspace. The reference application is written in Java and demonstrates the implementation of a TRS Provider using change requests as the resources that are being created, modified and deleted.  JAX-RS, an annotation based Java RESTful specification, and Apache Wink, a JAX-RS server side component, are used to define and serve up the TRS provider endpoints.

While this reference application depends on certain technlogoies, the core TRS concepts demonstrated within may be applied to other languages, frameworks, and resource domains.