Introduction

This document will guide you through importing ServiceMix 3.0 into the IDE Eclipse Java Development Tools v3.x.

Pre-Installation Requirements

Hardware:

52 MB of free disk space for the ServiceMix 3.x binary distribution.
18 MB of free disk space for the ServiceMix 3.x source or developer's distributions.

Operating Systems:

Windows: Windows XP SP2, Windows 2000.
Unix: Ubuntu Linux, Powerdog Linux, MacOS, AIX, HP-UX, Solaris, any Unix platform that supports Java.

Environment:

Java Developer Kit (JDK) 1.5.x (Java 5) for compiling/building.
The JAVA_HOME environment variable must be set to the directory where the JDK is installed, e.g., c:\Program Files\jsdk.1.5.x
Maven 2 or greater.
Eclipse 3.x or greater.

Importing ServiceMix

Below are the steps to import ServiceMix as a project in Eclipse.

Preparing the Files for Eclipse

Grab the sources from svnor download servicemix source distribution.
Open a command line and change to the source root folder. Execute the following Maven 2 command to ready the project for Eclipse. It will take around two minutes.
```
mvn eclipse:eclipse
```

In Eclipse:

From the "File" menu select "Import".
Select "Existing Projects into Workspace" and click "Next"
Browse for the root directory, which is the directory in which you downloaded ServiceMix. "Select All" the files in the Import pop-up window. They are probably already pre-selected for you (check box is checked). Un-checking the option "Copy projects into workspace" allows you to automatically always edit the current version of the SVN checkout folder, thus avoiding an import after each SVN update. Click "Finish" in the Import window; the import takes around three minutes.
From the "Windows" menu and click "Preferences"
The Preferences window will pop-up.
Click on the "Java" plus sign and change to "Compiler".
Compiler compliance level must be 5.0, pull down menu and select.
Check the "Use default compliance settings" box.
Then check under "Installed JREs" that you have JDK 5, e.g., jre_1.5.x
Click on "Build Path" and then select "Classpath Variables".
Click on "New" button to right
A pop-up appears.
Enter the Name: M2_REPO
Enter the Path of your local maven repository, usually located in <your home directory>\.m2, for example:
C:\Documents and Settings\exjobb\.m2\repository
Click "OK" button. The necessary build takes around three minutes.

Running an Example

Now you can run an example:

In the Package Explorer find the Main class, which should be located in: servicemix-core/src/main/java/
under org.apache.servicemix/Main.java.
Double click on the main() method.
From the Run menu select "Run..."
You will get a Run window pop-up, from there select Java Application.
1. Click on New button in botton left (Eclipse <3.2) or the icon in the top left (Eclipse v3.2)
2. Name the Project: any name you like, for example if you want to run the FilePoller / FileBinding application call it "filepoller", so it's easy for you to remember what this run configuration does.
3. Click on "Arguments" tab:
  1. In the "Program Arguments" box enter servicemix.xml
  2. In the Working Directory enter the path of your example. Such as
    S:\apache-servicemix\src\main\release\examples\file-binding
    where S:\ is assumed as your servicemix root directory.
    You can use the "File System..." button to browse for your directory.
4. Click on the tab "Classpath" to give Eclipse needed information on where to search for executable files. This description sticks to the file-binding example, but a similar procedure will be needed for most examples and your own code as well. There are three main ways to add classes to the classpath:
  1. You can add other projects of the workbench. Doing this will make the file-binding example run.
    1. Click "User Entries"
    2. Click "Add Projects" and click the checkbox(es) in front of the project(s) that are required. For convenience reasons you may click "Select All".
    3. Click "OK". Now your Run-dialog shall look similar to this screenshot:
  2. You can add JARs and classes that are stored within a classpath environment variable. This is not required for the file-binding example, but possible, e.g. if you want to run a specific ServiceMix version from a JAR for bug reproduction or the like - this case is used for the following description. Often, this way is used to reference depenedencies Maven downloads automatically for you.
    1. Click "User Entries"
    2. Click "Advanced", "Add Classpath Variables" and "OK"
    3. Check M2_REPRO and click "Extend"
    4. Choose the JAR containing the bytecode for the missing classes. If you want to run SOME_VERSION of ServiceMix, choose /org/apache/servicemix/servicemix-core/SOME_VERSION/servicemix-core-SOME_VERSION.jar
      
      In case you want to reference a dependency, proceed in the same way. In case you do not know which package you shall select, see below.
    5. Click "OK"
  3. You can add arbitrary folders to the classpath. This is usually only needed for your own code. To explain the workflow, let's assume you did not add any projects, thus your file-binding example does not run and the console window contains this message:
    Error 'Bean class [org.apache.servicemix.components.file.FileWriter] not found'
    1. Click "User Entries"
    2. Click "Advanced", "Add External Folder" and "OK"
    3. When S:\ is your servicemix root directory, select/enter
      S:\servicemix-components\target\classes
      
      Why this directory? Well, have a closer look at the error message presented above. The package org.apache.servicemix.components indicates the location of the missing bean FileWriter is servicemix-components, and as we need an executable file, the target\classes subdirectory is where to look. Of course we shall proof that FileWriter really is located here, so execute dir /s FileWriter.class in the given directory and watch the output.
    4. Click "OK".
      #Click Apply.
      #Click Run.

TODO

error message

java.lang.NoClassDefFoundError: org/apache/servicemix/Main

class file not found. execute

mvn install

to get a build

Error 'Bean class [org.apache.servicemix.components.file.FileWriter] not found'

Why this directory? Well, have a closer look at the error message presented above. The package org.apache.servicemix.components indicates the location of the missing bean FileWriter is servicemix-components, and as we need an executable file, the target\classes subdirectory is where to look. Of course we shall proof that FileWriter really is located here, so execute dir /s FileWriter.class in the given directory and watch the output.

When you run the example, Eclipse will show in the Console window error messages like "Error creating bean with name", "java.lang.NoClassDefFoundError" or similar. Scan the messages from top to bottom until you find the missing component, indicated by a package name - in case it's a "java.lang.NoClassDefFoundError" or "java.lang.ClassNotFoundException", the missing class is printed directly after that error string.

First extract the package name (eg: "java.lang.ClassNotFoundException: org.quartz.SimpleTrigger" tells you that the package org.quartz is missing). Add the required library to the classpath like stated above for "Add Classpath Variables". Look for a folder matching the missing package (sometimes the TLD is omitted, so package org.quartz may be placed in folder quartz), and choose a JAR containing executable bytecode classes (so not the quartz-1.5.1-sources.jar but quartz-1.5.1.jar) within the folder. Redo this procedure until no JAR is missing any more.

TODO

Configuring Eclipse

Updating Eclipse from Trunk

Browse the "Project" menu and select "Properties"
Click "Java BuildPath" and under the "Libraries" tab click "Add External Jar".
Browse to the incubator-servicemix-3.0-SNAPSHOT.jar location:
\target\incubator-servicemix-3.0-SNAPSHOT\bin\incubator-servicemix-3.0-SNAPSHOT and Click "Open" then "OK" in the "Properties" screen
Allow some time for the individual projects to build.

Child pages

Importing ServiceMix into Eclipse