Skip to main content

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.

Jump to: navigation, search

Lyo/BuildingOSLC4J

< Lyo

Building and Running Lyo OSLC4J applications in Eclipse

This page in an outdated description of how to build and use OSLC4J from source code. Unless you are an advanced user, you are recommened to follow these Getting Started With OSLC4J Instructions.

Prerequisites

See Lyo/prereqs.

OSLC4J Sample Application runtimes

The OSLC4J sample applications now use a Jetty app server as the default runtime. The samples will also work in an Eclipse IDE using a Tomcat runtime. See the Eclipse documentation for instructions on creating a Tomcat server.

Note: If you're running these examples on Windows, make sure you don't have spaces in your workspace path. The samples might not launch.

Note: By default, these samples each run in a different Jetty instance and use the same ports. You can only run one at a time.

Options for running the OSLC4J Samples

You can develop and run OSLC4J samples one of 2 ways

  • Build OSLC4J and samples from source
  • Download the OSLC4J package with its dependencies here and add the jars to the classpath of your project

The remainder of this document explains the process for building from source.

Clone the Lyo Core and RIO (optional, for Change and Quality Management samples) git repositories

This example assumes EGit is being used

Lyo-core-git-repo.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 OSLC4J 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
  • Select all components of OSLC4J core. The org.eclipse.lyo.core.query project is optional and not part of the core of OSLC4J at this point.

Build all projects

To build the core projects

  • Go to Run->Run Configurations
  • Expand the Maven Build section
  • Select Build OSLC4J
  • If you are using a Mac you need to add a parameter to make JavaDoc run correctly.
    • In the Main tab, next to the Parameter Name list, select Add...
    • Add a parameter to point to the Javadoc.exe location:
      • Parameter Name: mac_local_javadoc_exe
      • Value: (the location of your local javadoc.exe location, for example:
       /Library/Java/JavaVirtualMachines/jdk1.7.0_79.jdk/Contents/Home/bin/javadoc)
    • Select OK to close the Edit Parameter dialog box.
    • Select Apply to save the launch config
  • Select Build OSLC4J and click Run

To build the stock quote sample and OSLC4J test projects

  • Right the org.eclipse.lyo.oslc4j.test.build project -> Run As -> Maven install

Run the StockQuote sample application

  • Expand the org.eclipse.lyo.oslc4j.test.build project
  • Right click pom.xml -> Run As -> Maven install
  • Go to Run->Run Configurations
  • Expand the Maven Build section
  • Select Launch OSLC4JStockQuote and click Run
  • Test that the server is running by going to this URL in the web browser: http://localhost:8080/OSLC4JStockQuote/stockQuotes. You should get an OSLC response with some recent stock quotes (if you have internet connectivity).

Run the StockQuote JUnit tests

  • Expand the org.eclipse.lyo.oslc4j.stockquote.test project down to the Java source
  • Right click AllTests.java -> Run As -> JUnit test
  • Results will appear in the JUnit view

Run the Change Management sample provider

Note: the sample UIs for the Change Management sample provider have not yet been committed to Eclipse. The delegated selection and creation dialogs will not work yet

  • From the Git Repository view, right click the git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.rio.git repository (browse it also on line) and import projects :
    • org.eclipse.lyo.oslc4j.changemanagement
    • org.eclipse.lyo.oslc4j.changemanagement.common
    • org.eclipse.lyo.oslc4j.changemanagement.test
  • Build each CM project by right clicking its pom.xml and selecting Run As->Maven install. Build them in this order:
  * org.eclipse.lyo.oslc4j.changemanagement.common
  * org.eclipse.lyo.oslc4j.changemanagement
  * org.eclipse.lyo.oslc4j.changemanagement.test

Run the Change Management JUnit tests

  • Expand the org.eclipse.lyo.oslc4j.changemanagement.test project down to the Java source
  • Right click AllTests.java -> Run As -> JUnit test
  • Results will appear in the JUnit view

Run the Quality Management sample provider

Note: the sample UIs for the Quality Management sample provider have not yet been committed to Eclipse. The delegated selection and creation dialogs will not work yet

  • From the Git Repository view, right click the git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.rio.git repository (browse it also on line) and import projects :
    • Select the org.eclipse.lyo.oslc4j.qualitymanagement, org.eclipse.lyo.oslc4j.qualitymanagement.common and org.eclipse.lyo.oslc4j.qualitymanagement.test projects. The other projects in the rio repository are unrelated to OSLC4J. See Lyo RIOs for information on these other reference implementations.
  • Build each QM project by right clicking its pom.xml and selecting Run As->Maven install. Build them in this order:
  * org.eclipse.lyo.oslc4j.qualitymanagement.common
  * org.eclipse.lyo.oslc4j.qualitymanagement
  * org.eclipse.lyo.oslc4j.qualitymanagement.test

Run the Quality Management JUnit tests

  • Expand the org.eclipse.lyo.oslc4j.qualitymanagement.test project down to the Java source
  • Right click AllTests.java -> Run As -> JUnit test
  • Results will appear in the JUnit view

Run the Automation sample provider

  • From the Git Repository view, right click the git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.rio.git repository (browse it also on line) and import projects :
    • Select the org.eclipse.lyo.oslc4j.automation, org.eclipse.lyo.oslc4j.automation.common, and org.eclipse.lyo.oslc4j.automation.test projects. The other projects in the rio repository are unrelated to OSLC4J. See Lyo RIOs for information on these other reference implementations.
  • Build each Automation project by right clicking its pom.xml and selecting Run As->Maven install. Build them in this order:
  * org.eclipse.lyo.oslc4j.automation.common
  * org.eclipse.lyo.oslc4j.automation
  * org.eclipse.lyo.oslc4j.automation.test

You should now be able to point a local web browser at http://localhost:8080/OSLC4JAutomation/ and start working with the reference implementation.

Run the Automation JUnit tests

  • Expand the org.eclipse.lyo.oslc4j.automation.test project down to the Java source
  • Right click AllTests.java -> Run As -> JUnit test
  • Results will appear in the JUnit view

The OSLC4J registry web application

The OSLC4J StockQuote, Test, ChangeManagement and QualityManagement all use the OSLC4J registry web application as an OSLC Catalog. When each application starts, it registers its OSLC service provider details with the OSLC4J registry.

The sample applications are currently configured to automatically launch the OSLC4J registry in the same application server as the sample application and register with this local OSLC4J registry instance. If you wish to change this behavior and have the applications register with a remote OSLC4J registry, two changes are required.

  • Edit the pom.xml for the sample application and remove the following lines:
<!-- Also start OSLC4JRegistry webApp -->
<contextHandlers>
   <contextHandler implementation="org.eclipse.jetty.webapp.WebAppContext">
      <war>${basedir}/../../org.eclipse.lyo.core/org.eclipse.lyo.oslc4j.registry/target/oslc4j-registry-<version>-SNAPSHOT.war</war>
      <contextPath>/OSLC4JRegistry</contextPath>
      </contextHandler>
</contextHandlers>
  • Add the following system property to the JVM arguments for the application launch:
    • -Dorg.eclipse.lyo.oslc4j.client.registryuri=http://<hostname>:<port>/OSLC4JRegistry/catalog/singleton (assuming a context of OSLC4JRegistry)

The system property can also be set by modifying the application code to set it directly, load it from a properties file, etc.

Back to the top