Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Lyo/TRSSDK"
| Line 1: | Line 1: | ||
| − | The Tracked Resource Set (TRS) Software Development Kit (SDK) consists of two primary pieces; a toolkit and reference applications. | + | The Tracked Resource Set (TRS) Software Development Kit (SDK) consists of two primary pieces; a toolkit and reference applications. |
| − | = TRS Toolkit = | + | = 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. | + | 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. |
| + | <br> | ||
| + | == Loading the TRS Toolkit == | ||
| − | == | + | === Prerequisites === |
| − | + | *[http://eclipse.org/downloads Eclipse 3.6 or higher IDE] | |
| − | + | *[http://eclipse.org/egit/download/ EGit ]team provider for git (recommended) or [[Git command line package|git command line package]]. | |
| − | *[http://eclipse.org/downloads Eclipse 3.6 or higher IDE] | + | *[http://www.eclipse.org/m2e/download/ m2eclipse ]for Maven support in the Eclipse IDE |
| − | *[http://eclipse.org/egit/download/ EGit ]team provider for git (recommended) or [[ | + | |
| − | *[http://www.eclipse.org/m2e/download/ 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. | *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<br>Select the Import Existing Projects wizard and click Next<br>Import the following projects:<br>OSLC4J | |
| − | + | OSLC4JJenaProvider | |
| − | + | OSLC4JJson4JProvider | |
| − | + | OSLC4JWink | |
| − | + | org.eclipse.lyo.core.utils | |
| − | + | org.eclipse.lyo.core.trs | |
| − | <br> | + | <br>You may import the other projects if you like, but they are not required for building the TRS Toolkit. |
| − | + | <br> | |
| + | [Optional] Add the projects to a new working set.<br>[edit] Build all projects | ||
| + | Expand the OSLC4J project<br>Right click pom.xml -> Run As -> Maven clean<br>Right click pom.xml -> Run As -> Maven install<br>Repeat these steps for the OSLC4JJenaProvider and OSLC4JJson4JProvider projects<br>[edit] Clone the Lyo Client git repository | ||
| − | + | This example assumes EGit is being used. | |
| + | Open the Git Repositories view in Eclipse and click the Clone Git Repository icon<br>Use git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.client.git as the URI (browse it also on line). User/Password are not required. | ||
| + | <br>On the Branch Selection page, select the master branch<br>On the Local Destination page, specify a location or accept the default and click Finish<br>The repository should now show up in your Git Repositories view. | ||
| + | [edit] Import Eclipse projects from the git repository | ||
| + | In the Git Repositories view, right click org.eclipse.lyo.client and select Import Projects<br>Select the Import Existing Projects wizard and click Next<br>Import the following projects:<br>org.eclipse.lyo.client.java<br>org.eclipse.lyo.samples.clients | ||
| + | |||
| + | <br>[Optional] Add the projects to a new working set.<br>[edit] Build all projects | ||
| + | |||
| + | Expand the org.eclipse.lyo.clients.java project<br>Right click pom.xml -> Run As -> Maven clean<br>Right click pom.xml -> Run As -> Maven install<br>Repeat these steps for the org.eclipse.lyo.samples.client project | ||
| + | |||
| + | <br> | ||
| + | |||
| + | == Exploring the TRS Toolkit == | ||
Beans TrackedResourceSet Base AbstractChangeLog ChangeLog EmptyChangeLog ChangeEvent Creation Modification Deletion | Beans TrackedResourceSet Base AbstractChangeLog ChangeLog EmptyChangeLog ChangeEvent Creation Modification Deletion | ||
| Line 62: | Line 77: | ||
<br> toolkit-trs-deluxe The goal of the toolkit-trs-deluxe library is to provide the most inclusive library stack for adopting TRS. This library has the most dependencies and is usually more suited for newer project developments looking to get the biggest headstart . Additionally, a concrete example of this framework is implemented in the TRS Reference application. This library framework will provide the ability for: Generating the TRS services via JAX-RS using Apache Wink (De)Serialization of the TRS Beans through OSLC4J The main addition to this tier is the additional libraries (oslc4j-wink [1.0], oslc4j-jena-provider [1.1-SNAPSHOT]) to support the features enumerated above. | <br> toolkit-trs-deluxe The goal of the toolkit-trs-deluxe library is to provide the most inclusive library stack for adopting TRS. This library has the most dependencies and is usually more suited for newer project developments looking to get the biggest headstart . Additionally, a concrete example of this framework is implemented in the TRS Reference application. This library framework will provide the ability for: Generating the TRS services via JAX-RS using Apache Wink (De)Serialization of the TRS Beans through OSLC4J The main addition to this tier is the additional libraries (oslc4j-wink [1.0], oslc4j-jena-provider [1.1-SNAPSHOT]) to support the features enumerated above. | ||
| + | <br> | ||
| − | + | = TRS Reference Application = | |
| − | = TRS Reference Application = | + | |
Before following the steps in this section please make sure the TRS Toolkit from section 1 has been loaded into your | Before following the steps in this section please make sure the TRS Toolkit from section 1 has been loaded into your | ||
Revision as of 13:31, 8 March 2013
The Tracked Resource Set (TRS) Software Development Kit (SDK) consists of two primary pieces; a toolkit and reference applications.
Contents
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.
[edit] 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 OSLC4JJenaProvider and OSLC4JJson4JProvider projects
[edit] Clone the Lyo Client 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.client.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.
[edit] Import Eclipse projects from the git repository
In the Git Repositories view, right click org.eclipse.lyo.client and select Import Projects
Select the Import Existing Projects wizard and click Next
Import the following projects:
org.eclipse.lyo.client.java
org.eclipse.lyo.samples.clients
[Optional] Add the projects to a new working set.
[edit] Build all projects
Expand the org.eclipse.lyo.clients.java project
Right click pom.xml -> Run As -> Maven clean
Right click pom.xml -> Run As -> Maven install
Repeat these steps for the org.eclipse.lyo.samples.client project
Exploring the TRS Toolkit
Beans TrackedResourceSet Base AbstractChangeLog ChangeLog EmptyChangeLog ChangeEvent Creation Modification Deletion
toolkit-trs-enhanced No toolkit for the enhanced tier is provided at this time.
toolkit-trs-deluxe The goal of the toolkit-trs-deluxe library is to provide the most inclusive library stack for adopting TRS. This library has the most dependencies and is usually more suited for newer project developments looking to get the biggest headstart . Additionally, a concrete example of this framework is implemented in the TRS Reference application. This library framework will provide the ability for: Generating the TRS services via JAX-RS using Apache Wink (De)Serialization of the TRS Beans through OSLC4J The main addition to this tier is the additional libraries (oslc4j-wink [1.0], oslc4j-jena-provider [1.1-SNAPSHOT]) to support the features enumerated above.
TRS Reference Application
Before following the steps in this section please make sure the TRS Toolkit from section 1 has been loaded into your