Difference between revisions of "Lyo/BuildClient"

From Eclipsepedia

< Lyo
Jump to: navigation, search
Line 1: Line 1:
 
The Lyo Client provides helpful APIs and sample code that can be used to interact with OSLC Service Providers.  It provides an additional layer of functionality on top of Apache HttpClient, Apache Wink, and OSLC4J that can give you a head start on some of the common use cases such as form login, OAuth handling, service discovery, sending queries, and processing query results.  It also provides sample code that demonstrates how to use the Lyo client in interesting ways, such as acting as a remote agent for an OSLC Automation service provider.
 
The Lyo Client provides helpful APIs and sample code that can be used to interact with OSLC Service Providers.  It provides an additional layer of functionality on top of Apache HttpClient, Apache Wink, and OSLC4J that can give you a head start on some of the common use cases such as form login, OAuth handling, service discovery, sending queries, and processing query results.  It also provides sample code that demonstrates how to use the Lyo client in interesting ways, such as acting as a remote agent for an OSLC Automation service provider.
  
= Building and Running the Lyo Client in Eclipse  =
+
= Building the Lyo Client in Eclipse  =
  
 
== Prerequisites  ==
 
== Prerequisites  ==
Line 108: Line 108:
 
* Right click pom.xml -> Run As -> Maven install
 
* Right click pom.xml -> Run As -> Maven install
 
* Repeat these steps for the org.eclipse.lyo.samples.client project
 
* Repeat these steps for the org.eclipse.lyo.samples.client project
 +
 +
= Running the Lyo Client samples in Eclipse  =
 +
 +
The '''org.eclipse.lyo.samples.clients''' project contains sample code that uses the Lyo client to interact with OSLC Service Providers in various ways.
 +
 +
== GenericCMSample ==
 +
 +
This sample demonstrates how to use the Lyo client to interact with a Change Management (CM) Service Provider in the following ways:
 +
* run an OLSC ChangeRequest query and retrieve OSLC ChangeRequests and de-serialize them as Java objects
 +
* retrieve an OSLC ChangeRequest and print it as XML
 +
* create a new ChangeRequest
 +
* update an existing ChangeRequest
 +
 +
To run the sample you first need access to a running Change Management Service Provider. You could use a product that implements the [http://open-services.net/bin/view/Main/CmSpecificationV2 OSLC V2 Change Management Specification].  The Eclipse Lyo project also provides a [[Lyo/BuildRIO | Reference Implementation]].

Revision as of 19:58, 16 October 2012

The Lyo Client provides helpful APIs and sample code that can be used to interact with OSLC Service Providers. It provides an additional layer of functionality on top of Apache HttpClient, Apache Wink, and OSLC4J that can give you a head start on some of the common use cases such as form login, OAuth handling, service discovery, sending queries, and processing query results. It also provides sample code that demonstrates how to use the Lyo client in interesting ways, such as acting as a remote agent for an OSLC Automation service provider.

Contents

Building the Lyo Client in Eclipse

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.

Lyo client core git.png

  • 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

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

Lyo core import projects.png

  • [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 OSLC4JJenaProvider and OSLC4JJson4JProvider projects

Clone the Lyo Server git repository

This example assumes EGit is being used.

Lyo server clone git.png

  • 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.server and select Import Projects
  • Select the Import Existing Projects wizard and click Next
  • Import the following project:
    • org.eclipse.lyo.server.oauth.core

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

Lyo server import projects.png

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

Build the project

  • Expand the org.eclipse.lyo.server.oauth.core project
  • Right click pom.xml -> Run As -> Maven clean
  • Right click pom.xml -> Run As -> Maven install

Clone the Lyo Client git repository

This example assumes EGit is being used.

Lyo client clone git.png

  • 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.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

Lyo client import projects.png

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

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

Running the Lyo Client samples in Eclipse

The org.eclipse.lyo.samples.clients project contains sample code that uses the Lyo client to interact with OSLC Service Providers in various ways.

GenericCMSample

This sample demonstrates how to use the Lyo client to interact with a Change Management (CM) Service Provider in the following ways:

  • run an OLSC ChangeRequest query and retrieve OSLC ChangeRequests and de-serialize them as Java objects
  • retrieve an OSLC ChangeRequest and print it as XML
  • create a new ChangeRequest
  • update an existing ChangeRequest

To run the sample you first need access to a running Change Management Service Provider. You could use a product that implements the OSLC V2 Change Management Specification. The Eclipse Lyo project also provides a Reference Implementation.