* Repeat these steps for the org.eclipse.lyo.client.java.sample project

= Running the Lyo Client samples in Eclipse =

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

+

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

== GenericCMSample ==

== GenericCMSample ==

Line 87:

Line 87:

* update an existing ChangeRequest

* update an existing ChangeRequest

−

To run the sample you first need to follow the instructions to build and run the [[Lyo/BuildingOSLC4J| Change Management Reference Implementation]]. Then you can create a launch configuration in eclipse to run GenericCMSample as a java application, passing in values for the command line arguments as shown below:

+

To run the sample you first need to follow the instructions to build and run the [[Lyo/BuildingOSLC4J| Change Management Reference Implementation]]. Then you can create a launch configuration in eclipse to run GenericCMSample as a java application.

+

+

* Go to the ''org.eclipse.lyo.samples.clients'' project and follow the src/main/java directory

+

* Open up the ''org.eclipse.lyo.client.oslc.samples'' package

+

* Right-click on the GenericCMSample.java program, and select '''Run As -> Run Configurations'''.

+

* Pass in the following values for the command line arguments as shown below:

[[Image:RunGenericCMSample.png]]

[[Image:RunGenericCMSample.png]]

Line 117:

Line 122:

== DoorsOauthSample ==

== DoorsOauthSample ==

−

This sample demonstrates how to use the Lyo client to interact with IBM Rational DOORS in the following ways

+

This sample demonstrates how to use the Lyo client to interact with IBM Rational DOORS in the following ways:

+

+

* Connects to IBM Rational DOORS using OAuth

+

* Creates a requirement in DOORS

+

+

It then attempts to update that requirement but there is an outstanding issue with dates leading to errors.

Revision as of 16:53, 5 February 2014

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.

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.java.sample

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

Build all projects

Expand the org.eclipse.lyo.client.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.client.java.sample project

Running the Lyo Client samples in Eclipse

The org.eclipse.lyo.client.java.sample 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 to follow the instructions to build and run the Change Management Reference Implementation. Then you can create a launch configuration in eclipse to run GenericCMSample as a java application.

Go to the org.eclipse.lyo.samples.clients project and follow the src/main/java directory

Open up the org.eclipse.lyo.client.oslc.samples package

Right-click on the GenericCMSample.java program, and select Run As -> Run Configurations.

Pass in the following values for the command line arguments as shown below:

RQMFormSample

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

run an OLSC TestResult query and retrieve OSLC TestResults and de-serialize them as Java objects

retrieve an OSLC TestResult and print it as XML

create a new TestCase

update an existing TestCase

To run this sample you can install and configure a Quality Management V2 service provider such as Rational Quality Manager. Then create a launch configuration in eclipse to run RQMFormSample as a java application, passing in values for the command line arguments as shown below:

RTCFormSample

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 this sample you can install and configure a Change Management V2 service provider such as Rational Team Concert. Then create a launch configuration in eclipse to run RTCFormSample as a java application, passing in values for the command line arguments as shown below:

DoorsOauthSample

This sample demonstrates how to use the Lyo client to interact with IBM Rational DOORS in the following ways:

Connects to IBM Rational DOORS using OAuth

Creates a requirement in DOORS

It then attempts to update that requirement but there is an outstanding issue with dates leading to errors.

It requires DOORS Web Access 9.5.0 or later. Ideally 9.5.1.2+.

In DOORS go to File-OSLC-Local Keys (or Database Properties-Local Keys in 9.5.0.x).
Add a new OAuth Consumer by giving a name, key and secret. Note the key and secret used.

Edit the DoorsOauthSample.java. Locate this section and replace the consumer key and secret with what was registed with DOORS:

//STEP 2: Create a new OSLC OAuth capable client, the parameter of following call should be provided
// by the system administrator of the DOORs Web Access server
e.g

OslcOAuthClient client = helper.initOAuthClient("lyo", "lyo");

Right click and select Run As - Run Configuration. Under Arguments add the connection details for your DOORS Web Access and a module name. e.g.

RQMAutomationSample

This sample demonstrates how to use the Lyo client to interact with an Automation Service Provider. It provides an Automation Adapter resource which can be used to communicate with the Automation Provider for activities such as polling for Automation Requests. It also provides a sample application that demonstrates how to initialize the Automation Adapter and register it with the Automation Provider.

When an Automation Request becomes available the Automation Adapter takes ownership of the request and gives control back to the sample application for execution of a test script. While the test automation is underway the sample application uses the Automation Adapter to send progress updates to the Automation Service Provider. When the test automation has completed the sample application uses the Automation Adapter to upload an attachment to the Service Provider and send an Automation Result back to the Automation Provider.

To run this sample you can install and configure a Automation Service Provider such as Rational Quality Manager. Then update the adapter.properties file with the information about your Adapter client and the Automation Provider.

Finally, to run the Sample application right click RQMAutomationSample.java in your Explorer view and select Run As->Java Application.