Difference between revisions of "SMILA/Development Guidelines/How to set up integration environment"

From Eclipsepedia

Jump to: navigation, search
m (Create a new Workspace and setup target platform)
m (Create a new Workspace and setup target platform)
Line 21: Line 21:
 
==== Create a new Workspace and setup target platform ====
 
==== Create a new Workspace and setup target platform ====
  
Start your Eclipse SDK and let it create a new workspace at a location of your choice. Then you use the SMILA binaries as the target platform for plugin develoment. This enables you to create own bundles that can use the code in the SMILA bundles:
+
Start your Eclipse SDK and create a new workspace at a location of your choice. Then use the SMILA binaries as the target platform for plugin develoment. This enables you to create own bundles that can use the code in the SMILA bundles:
  
 
* Open "Windows" -> "Preferences".
 
* Open "Windows" -> "Preferences".

Revision as of 06:01, 28 September 2011


This how-to describes the necessary steps for setting up SMILA integration environment. Normally this setup is only interesting for SMILA integrators who just want to integrate their components in SMILA. SMILA committers and contributors should work with another setup described at How to set up the development environment.

Contents

Preconditions

Here is the list of things that you will definitely need for developing SMILA components:

  1. JDK 1.6
  2. Eclipse SDK - This howto was tested with Eclipse 3.6.2 (Helios) and Eclipse 3.7 (Indigo) (some details like bundle version numbers may be slightly different when using Indigo)
  3. SMILA binary distribution

Install the binary distribution

Just pick up the latest binary distribution of SMILA:

Simply unzip the file you downloaded into a new directory on your local hard disk and you've done with the installation.

Create a new Workspace and setup target platform

Start your Eclipse SDK and create a new workspace at a location of your choice. Then use the SMILA binaries as the target platform for plugin develoment. This enables you to create own bundles that can use the code in the SMILA bundles:

  • Open "Windows" -> "Preferences".
  • Select "Plug-in Development" --> "Target Platform" --> "Add".
  • Initialize the target definition with: "Nothing --> Next".
  • Enter a reasonable name (how about "SMILA", maybe? ;-).
  • In the "Locations" tab, click "Add".
    • Select "Installation" --> Click "Next".
    • Click "Browse" and navigate to the directory where you installed SMILA (do not press <Enter> yet).
    • --> Click "Finish".
  • Back on the "Locations" tab, click "Add" again.
    • Select "Features" --> Click "Next"
    • In the "Location" text field enter "${eclipse_home}" (without parentheses).
    • Select the features "org.eclipse.jdt" and "org.eclipse.platform".
    • --> Click "Finish"
  • Switch to the "Content" tab:
    • Filter for "junit" and deselect the bundles "org.junit (4.8.1)" and "org.junit4 (4.8.1)". Only "org.junit (3.8.2)" must be selected.
  • --> Click "Finish"
  • Select the new target platform.
  • --> Click "OK", you're done.

Create a launch configuration for SMILA

Getting right the launch configuration for SMILA is a bit tedious, so we prepared an example package:

  • Either checkout the contents of https://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/examples from our SVN repository into your workspace
  • or download them as one package from http://build.eclipse.org/rt/smila/nightly/SMILA-integrator-examples.zip and unpack and import them into your workspace.
    • Select File > Import.
    • Select General > Existing Projects into Workspace and click Next.
    • Click Browse, navigate to the folder where you have unpacked the zip or chave checked out the contents and select <SDK>/bundles, and confirm with OK.
    • Select all projects, enable the option Copy projects into workspace, and click Finish.
    • now you should have following projects:
      • org.eclipse.smila.integration.worker
      • org.eclipse.smila.integration.worker.test
      • org.eclipse.smila.integration.pipelet
      • org.eclipse.smila.integration.feature
      • SMILA.application

To launch SMILA, you need only the "SMILA.application" project. The other bundles contain examples for developing integration components like workers, pipelets, etc.

In the menu, open "Run" -> "Run Configurations" or "Debug Configurations" and you should find an entry "OSGi Frameworks" -> "SMILA". Select it and click "Run" or "Debug" and SMILA should start just like when started from the command line. The configuration of this SMILA instance is in your workspace in "SMILA.application/configuration".