Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

NEW (29.01.2024): We will change some dependency handling! For development with eclipse you must install the m2e PDE Integration into the Eclipse IDE.

After the installation it can be used in the PDE Target Editor.

06.02.2024: Due to a bug in Eclipse, you will need to use the latest eclipse version (2024-03):

Nearly everything in Odysseus is designed to be replaced or extended. Here are the typical ones:

  • Language extensions
    • Create a new language (not only for queries, could be a DSL for anything)
    • Create a new Odysseus Script Commands (#....)
    • Create a new Logical/PQL Operator
  • Processing function extensions
    • Create new datatypes
    • Create new stream object types
      • Data Handler
    • Create a new wrapper
      • Transport handler
      • Protocol handler
    • Create new functions for expressions and predicates
    • Create new aggregation functions
    • Create new operators
  • Create new schedulers and scheduling strategies
  • Create new meta data

Table of Contents

Some OSGi/Eclipse basics

  • Bundles
    • Aka plugin: An eclipse project
    • Each bundle has its own class loader
    • MANIFEST.MF: meta data for that bundle (name, version, imports, exports…)
    • In Odysseus: a module that encapsulates functions
  • Fragment
    • A special bundle that will not exist allone but together with a host bundle
    • Same class loader as host bundle
    • Used to extend host bundle
    • We do not use this anymore, better approach is declarative services
  • Declarative Services
    • OSGi way of dependency injection
    • Defined by so called components
    • Can provide functions by interfaces or use (bind/unbind) implementations by interfaces à examples later
  • Feature: a feature is a collection of bundles
    • Define a set of bundles, that belong together and builds some functionality (e.g. each wrapper has its own feature)
    • An update site provides features
    • A bundle can be part of many features
  • Update-site:
    • A collection of features that can be installed in Odysseus
    • On the same way, as in Eclipse („Install new software“)
    • Via command on ther server
    • Via Odysseus-Script
  • Product:
    • A product is a runnable software (with an application)
    • Can be defined by bundles or features
    • We only use features to define products

OSGi Life Cycle

  • Each bundle has a life cycle
  • Installed: A bundle (with correct Metadata is installed)
  • Resolved: All dependencies (MANIFEST) are found
  • Uninstalled: removed from runtime
  • Active: a bundle is activated
    • E.g. call of bundle activator
    • Remark: there is no need to start a bundle, if the bundle should only provide classes (as a library)
  • Eclipse tries to resolve dependencies lazy, if this cannot be done, the bundle stays installed --> bundle cannot be used

Image Added

OSGi debugging

TODO: Check commands with apache felix console

  • When an application (product) gets started with –console (as in Odysseus always), there is a console available
  • ss shows all currently available bundles and their current life cycle state
  • Sometimes, there are problems because dependencies are missing (INSTALLED)
  • Typical problem: The dependency defined in the MANIFEST.MF was not added to any feature
  • diag <id> shows the missing dependencies
  • Again: Resolved is no “problem” ;-)

Image Added

  • ls: shows all currently installed (declarative) services
  • Unsatisfied: Some dependencies cannot be found
  • Use comp <id> to determine missing dependencies

Image Added

Setting up Setting up

This section describes how to set up Eclipse and Odysseus for development.


1. Prerequisites

You will need the following tools:

2. Checkout Source Code

Remark: Under windows it is best to use a folder, that is not inside the user home path (because of long file names). A good option would be a base folder git somewhere on the root level.

There are different ways to create new functionality with Odysseus. The first way should be used if you want to add something new to Odysseus (e.g. a new wrapper) but do not want to change the common code base. This should be the preferred way of development with Odysseus:


Code Block
git clone --recurse-submodules newRepo
cd newRepo
cd odysseus_dev
git checkout master

Remark: because you are not allowed to push updates to the template repository you should change your repository URL to your git location and rename your folder to your new repository name.

Code Block
// in your newRepo Folder!
git remote set-url origin <new url>


There is also a first approach for an eclipse plugin that could make processing easier. For this, install the Odysseus Development Tools from the following update site

Code Block

and uncheck "Group items by category".

Image Added

After installation and restart there is a new menu option Odysseus where you can create an initial project:

Image Added

Image Added

Option 2: Extending an Existing Odysseus Plugin/Extending Odysseus Core

You want to extend an existing plugin from Odysseus or extend the core system? Then, instead of cloning the empty template from Option 1, clone the repository of the plugin you want to develop on. If the plugin is hosted in our Bitbucket, you can probably find it in one of the projects in this list: . Look for example at the Odysseus, the Odysseus Incubation and Odysseus Wrapper projects. When you have found the repository you want to use, check it out and don't forget to clone the submodule to get the target platform definition and the standard products:

Code Block
git clone --recurse-submodules <your repo URL>
cd <repo>
cd odysseus_dev
git checkout master

Remark: There could be some updates in odysseus_dev that is not already reflected in each module. So it is always a good idea to update the odysseus_dev submodule to the newest version.

If you missed the --recurse-submodules, you can also use:

Code Block
git clone <your repo URL>
cd <repo>
git submodule init
git submodule update
cd odysseus_dev
git checkout master
cd ..

3. Setup Eclipse

After Eclipse started, you have to import all bundles (these are the parts of Odysseus and are equal to an Eclipse project). Use "File -> Import -> Existing Projects into Workspace" to import them into Eclipse as follows:

Image RemovedImage Added

Image RemovedImage Added

After clicking "Next", select all needed projects.

Image Added

Now there are many project already opened:

Most of them are from odysseus_dev.

Image Added

The source code folder has the following subfolders:

  • client: contains all bundles that run on the client and don't have any dependencies to the server directly. It mainly offers the GUI.
  • common: this holds common stuff and utilities that are needed on both server and client. Common does not have any dependencies to other folders like server, client...
  • monolithic: this folder contains bundles that will only work in a monolithic system where server and client are the same product
  • resource: possibly some resources for the bundle, but probably empty. The resources are part of the target platform and are downloaded automatically by Eclipse when settings the target platform.
  • server: this is the server part of Odysseus and contains Odysseus main functionalities. Except of common, it does not have any dependencies to other folders. It does not have any GUI or client functionalities.
  • test: contains stuff for testing and benchmarking

Furthermore, each main folder has different subfolders. Each subfolder normally contains a certain functionality or a dedicated extension (aka plugin for Odysseus).

In the follwing screenshot some bundles are selected.

Image Removed

We recommend to create working sets like here to group certain bundles:

Image Removed

Image Removed


4. Target Platform

You probably only checked out the bundles you need, not the whole Odysseus core, resources and other stuff. All these things are part of the target platform and are loaded when setting the target platform for your workspace. Before you do that, you probably now see a lot of compiler errors. After you set the target platform, the errors should be gone. This definition is provided via the "" file (hint: if you don't see the target platform as a project when importing, go back to the git checkout project and make sure you cloned the submodule).error. This is because the target platform is not set.

The If you are using the project template, the target platform can be found in the project targetplatform. If you are making core odysseus development (which is unlikely), it  can be found in the bundle/project called "". Open this file and click "Set as target platform.

Image Added

Choose the correct Targetplatform for you work.

Remark: It works best, when you first open the file (double click) and wait some time (until the platform is resolved).

Image Added

Click "Set as Active Target Platform" to use this as your target platform. This can take a while. When you click on the small green progress-bar icon in Eclipse you can see the progress.

You can also use CRTL-SHIFT-R to search for the target platform

Image Removed

Image Removed

Notice, the target platform is valid for your whole workspace (therefore we recommend to use a dedicated workspace for Odysseus development).  Remark: Sometimes eclipse behaves strange when setting a new target platform. See Odysseus FAQ for further hints if there are problems with the target platform.

. Important: Do not click, if "Resolving..." is still active!

Image Added

After that, the project will be compiled and there should not be any errors anymore.

Image Added

If there are still errors, you should try to update the odysseus_dev folder (sometimes there are errors with the sites, that dliver target platform contents)Image Removed

5. First Run - Available Products

Now you should be able to run Odysseus. There are some predefined product-definitions to run Odysseus. Depending on the bundles/folders you checked out before they can differ, but the standard submodule should contain three products:

  • Odysseus Server .product - (located in - This is just a server-based instance of Odysseus (without any GUI) which can be used e.g. via a webservice REST.
  • Odysseus Studio 2 (Client) .product - (located in - This is only the client part (GUI), which tries to connect to an Odysseus Server instance via webservice.
  • Odysseus Studio 2 (Monolithic).product - (located in or product ) - This combines server and client into a single product and adds some additional bundles that only work in such a monolithic combination.

For your first run, the easiest way is to start the "Odysseus Studio 2 (Monolithic).product"" ( Open this file and go to the tab "Overview". Click "Synchronize" under "Testing" and afterwards click "Launch an Eclipse application" to run Odysseus (you can alternatively run it in debug mode if you want). When Odysseus Studio (the GUI) comes up, you have to insert some credentials. A default user is "System" and the password is "manager", the tenant can be left empty. Now Odysseus should be up and running.

Image Added

6. Additional Information


Odysseus comes with the Simple Logging Facade for Java (SLF4J). To use logging, add the bundle. In this bundle you can find the xml to configure the logging behavior .


Currently, only the server is working on MacOS. You can start the Odysseus Server product from Eclipse, but you cannot start any GUI product (e.g. Monolithic) that involves RCP. To run the server product, you have to install Java JDK 1.8, e.g. with homebrew: use one of the given).