Jump to: navigation, search

Difference between revisions of "Lyo/BuildingOSLC4J"

< Lyo
(The OSLC4JRegistry web application)
(17 intermediate revisions by 4 users not shown)
Line 2: Line 2:
  
 
== Prerequisites ==
 
== Prerequisites ==
* [http://eclipse.org/downloads Eclipse 3.6 or 3.7 IDE]
+
* [http://eclipse.org/downloads Eclipse 3.6 or higher IDE]
 
* [http://eclipse.org/egit/download/ EGit] team provider for git (recommended) or [http://git-scm.com/download git command line package].
 
* [http://eclipse.org/egit/download/ EGit] team provider for git (recommended) or [http://git-scm.com/download git command line package].
 
* [http://www.eclipse.org/m2e/download/ m2eclipse] for Maven support in the Eclipse IDE
 
* [http://www.eclipse.org/m2e/download/ m2eclipse] for Maven support in the Eclipse IDE
 
* OSLC4J 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.
 
* OSLC4J 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.
  
== OSLC4J Sample Application runtimes ==
+
== 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 [http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.jst.server.ui.doc.user%2Ftopics%2Ftomcat.html the Eclipse documentation] for instructions on creating a Tomcat server.
+
  
 +
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 [http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.jst.server.ui.doc.user%2Ftopics%2Ftomcat.html the Eclipse documentation] for instructions on creating a Tomcat server.
 +
<blockquote>'''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. </blockquote><blockquote>
 +
'''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.
 +
</blockquote>
 +
 +
== 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 [http://eclipse.org/lyo/download.php 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 ==
 
== Clone the Lyo Core and RIO (optional, for Change and Quality Management samples) git repositories ==
Line 32: Line 44:
  
 
== Build all projects ==
 
== Build all projects ==
* Expand the OSLC4JCoreRelEng project
+
 
 +
To build the core projects,
 +
 
 +
* Expand the org.eclipse.lyo.oslc4j.build project
 
* Right click pom.xml -> Run As -> Maven clean
 
* Right click pom.xml -> Run As -> Maven clean
 
* Right click pom.xml -> Run As -> Maven install
 
* Right click pom.xml -> Run As -> Maven install
 +
*'''IBM JVM/JRE Users:'''  There is an issue with m2eclipse and the the IBM JRE.  If you have see the error '''java.lang.NoClassDefFoundError: org.slf4j.impl.StaticLoggerBinder''' when running a Maven install, you need to copy a newer slf4j api jar into your JRE directory to work around the issue until it is fixed:
 +
** Download [http://slf4j.org/dist/slf4j-1.6.2.zip slf4j-1.6.2.zip] and extract the zip.
 +
** copy slf4j-api-1.6.2.jar from the slf4j distribution to the JAVA_HOME\jre\lib\ext directory
 +
** See https://bugs.eclipse.org/bugs/show_bug.cgi?id=338252 if you are interested in the details
 +
 +
To build the stock quote sample and OSLC4J test projects, perform the same steps on the org.eclipse.lyo.oslc4j.test.build project.
  
 
== Run the StockQuote sample application ==
 
== Run the StockQuote sample application ==
Line 41: Line 62:
 
* Expand the Maven Build section
 
* Expand the Maven Build section
 
* Select '''Launch OSLC4JStockQuote''' and click Run
 
* 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 ChangeRequest resources.
+
* 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).
 
** The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
 
** The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
  
 
=== Run the StockQuote JUnit tests ===
 
=== Run the StockQuote JUnit tests ===
* Expand the OSLC4JStockQuoteTest project down to the Java source
+
* Expand the org.eclipse.lyo.oslc4j.stockquote.test project down to the Java source
 
* Right click AllTests.java -> Run As -> JUnit test
 
* Right click AllTests.java -> Run As -> JUnit test
 
* Results will appear in the JUnit view
 
* Results will appear in the JUnit view
Line 52: Line 73:
 
'''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
 
'''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 <tt>git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.rio.git</tt> repository (browse it also [http://git.eclipse.org/c/lyo/org.eclipse.lyo.rio.git/ on line]) and import projects :
 
* From the Git Repository view, right click the <tt>git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.rio.git</tt> repository (browse it also [http://git.eclipse.org/c/lyo/org.eclipse.lyo.rio.git/ on line]) and import projects :
** Select the OSLC4JChangeManagement, OSLC4JChangeManagementCommon and OSLC4JChangeManagementTest projects.   The other projects in the rio repository are unrelated to OSLC4J.   See [[Lyo/LyoRio|Lyo RIOs]] for information on these other reference implementations.
+
** 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:
 
* Build each CM project by right clicking its pom.xml and selecting Run As->Maven install.  Build them in this order:
   * OSLC4JChangeManagementCommon
+
   * org.eclipse.lyo.oslc4j.changemanagement.common
   * OSLC4JChangeManagement
+
   * org.eclipse.lyo.oslc4j.changemanagement
   * OSLC4JChangeManagementTest
+
   * org.eclipse.lyo.oslc4j.changemanagement.test
 
* Go to Run->Run Configurations
 
* Go to Run->Run Configurations
 
* Expand the Maven Build section
 
* Expand the Maven Build section
 
* Select '''Launch OSLC4JChangeManagement''' and click Run
 
* Select '''Launch OSLC4JChangeManagement''' and click Run
* Test that the server is running by going to this URL in the web browser:  http://localhost:8080/OSLC4JChangeManagement/changeRequests.  You should get an OSLC response with some recent stock quotes (if you have internet connectivity).   
+
* Test that the server is running by going to this URL in the web browser:  http://localhost:8080/OSLC4JChangeManagement/changeRequests.  You should get an OSLC response with some ChangeRequest resources.   
 
** The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
 
** The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
  
 
=== Run the Change Management JUnit tests ===
 
=== Run the Change Management JUnit tests ===
* Expand the OSLC4JChangeManagementTest project down to the Java source
+
* Expand the org.eclipse.lyo.oslc4j.changemanagement.test project down to the Java source
 
* Right click AllTests.java -> Run As -> JUnit test
 
* Right click AllTests.java -> Run As -> JUnit test
 
* Results will appear in the JUnit view
 
* Results will appear in the JUnit view
Line 79: Line 102:
 
* Expand the Maven Build section
 
* Expand the Maven Build section
 
* Select '''Launch OSLC4JQualityManagement''' and click Run
 
* Select '''Launch OSLC4JQualityManagement''' and click Run
* Test that the server is running by going to this URL in the web browser:  http://localhost:8080/OSLC4JChangeManagement/testPlans.  You should get an OSLC response with some TestPlan resources.
+
* Test that the server is running by going to this URL in the web browser:  http://localhost:8080/OSLC4JQualityManagement/testPlans.  You should get an OSLC response with some TestPlan resources.
 
** The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
 
** The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
  
Line 87: Line 110:
 
* Results will appear in the JUnit view
 
* Results will appear in the JUnit view
  
 +
== Run the Automation sample provider  ==
  
= The OSLC4JRegistry web application =
+
*From the Git Repository view, right click the <tt>git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.rio.git</tt> repository (browse it also [http://git.eclipse.org/c/lyo/org.eclipse.lyo.rio.git/ on line]) and import projects&nbsp;:
The OSLC4J StockQuote, Test, ChangeManagement and QualityManagement all use the OSLC4JRegistry web application as an OSLC Catalog.   When each application starts, it registers its OSLC service provider details with OSLC4JRegistry.  
+
**Select the OSLC4JAutomation, OSLC4JAutomationCommon and OSLC4JAutomationTest projects. The other projects in the rio repository are unrelated to OSLC4J. See [[Lyo/LyoRio|Lyo RIOs]] for information on these other reference implementations.
 +
*Build each QM project by right clicking its pom.xml and selecting Run As-&gt;Maven install. Build them in this order:
  
The sample applications are currently configured to automatically launch the OSLC4JRegistry in the same application server as the sample application and register with this local OSLC4JRegistry instance.  If you wish to change this behavior and have the applications register with a remote OSLC4JRegistry, two changes are required.
+
  * OSLC4JAutomationCommon
 +
* OSLC4JAutomation
 +
* OSLC4JAutomationTest
  
* Edit the pom.xml for the sample application and remove the following lines:
+
*Go to Run-&gt;Run Configurations
 +
*Expand the Maven Build section
 +
*Select '''Launch OSLC4JAutomation''' and click Run
 +
*Test that the server is running by going to this URL in the web browser: http://localhost:8080/OSLC4JAutomation/services/autoPlans. You should get an OSLC response with some AutomationPlan resources.
 +
**The OSLC Catalog entry for this application can be found at http://localhost:8080/OSLC4JRegistry/catalog/singleton
  
                            <!-- Also start OSLC4JRegistry webApp -->
+
=== Run the Automation JUnit tests  ===
    <contextHandlers>
+
<contextHandler implementation="org.eclipse.jetty.webapp.WebAppContext">
+
<war>${basedir}/../../org.eclipse.lyo.core/OSLC4JRegistry/target/oslc4j-registry-0.1.1-SNAPSHOT.war</war>
+
<contextPath>/OSLC4JRegistry</contextPath>
+
</contextHandler>
+
    </contextHandlers>
+
  
 +
*Expand the OSLC4JAutomationTest project down to the Java source
 +
*Right click AllTests.java -&gt; Run As -&gt; 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:
 +
<source lang="xml">
 +
<!-- 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-0.1.1-SNAPSHOT.war</war>
 +
      <contextPath>/OSLC4JRegistry</contextPath>
 +
      </contextHandler>
 +
</contextHandlers>
 +
</source>
 
* Add the following system property to the JVM arguments for the application launch:
 
* 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)
 
** -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.
 
The system property can also be set by modifying the application code to set it directly, load it from a properties file, etc.

Revision as of 13:57, 18 July 2013

Building and Running Lyo OSLC4J applications 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
  • OSLC4J 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.

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.

Lyo-core-import-projects.png

Build all projects

To build the core projects,

  • Expand the org.eclipse.lyo.oslc4j.build project
  • Right click pom.xml -> Run As -> Maven clean
  • Right click pom.xml -> Run As -> Maven install
  • IBM JVM/JRE Users: There is an issue with m2eclipse and the the IBM JRE. If you have see the error java.lang.NoClassDefFoundError: org.slf4j.impl.StaticLoggerBinder when running a Maven install, you need to copy a newer slf4j api jar into your JRE directory to work around the issue until it is fixed:

To build the stock quote sample and OSLC4J test projects, perform the same steps on the org.eclipse.lyo.oslc4j.test.build project.

Run the StockQuote sample application

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 OSLC4JQualityManagement, OSLC4JQualityManagementCommon and OSLC4JQualityManagementTest 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:
  * OSLC4JQualityManagementCommon
  * OSLC4JQualityManagement
  * OSLC4JQualityManagementTest

Run the Quality Management JUnit tests

  • Expand the OSLC4JQualityManagementTest 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 OSLC4JAutomation, OSLC4JAutomationCommon and OSLC4JAutomationTest 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:
  * OSLC4JAutomationCommon
* OSLC4JAutomation
* OSLC4JAutomationTest

Run the Automation JUnit tests

  • Expand the OSLC4JAutomationTest 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-0.1.1-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.