This section describes how to set up Eclipse and Odysseus for developments.
You will need the following tools:
- Java 8 JDK
- Eclipse for RCP and RAP Developers (Important! Do not use a standard eclipse version!) e.g.: https://www.eclipse.org/downloads/packages/release/oxygen/3a/eclipse-rcp-and-rap-developers
Important: Photon currently doesn't work! Please use Eclipse Oxygen RCP RAP until we fixed the error.
- GIT Client (see next step for details)
2. Checkout Source Code
Source code is public available via git (from a Bitbucket server):
Odysseus is based on submodules, so the flag recurse-submodules is necessary.
3. Setup Eclipse
We recommend to use a dedicated Eclipse workspace for Odysseus, because a full import of Odysseus may have more than 300 Projects.The most simply way is as follows. If you are firstly starting Eclipse, choose the folder where you checked out the source code as the workspace location.
If you have already a workspace, you can switch it via "File -> Switch Workspace -> Other..."
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:
After clicking "Next", select all needed projects.The source code ("trunk") folder has the following subfolders:
- application: this folder contains all applications that use Odysseus or provide any data like generators.
- 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 und 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
- 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
- tooling: contains primarily tools for the build controlling (Jenkins)
Furthermore, each main folder has different subfolders. Each subfolder normally contains a certain functionality or a dedicated extension (aka plugin for Odysseus). The main functionality of Odysseus is called "core". So, if you want to have a minimal set of bundles for developing, you will need to import the following folders: "common" and the "core"-subfolder within "server".
In the follwing screenshot some bundles are selected.
We recommend to create working sets like here to group certain bundles:
4. Target Platform
Since Odysseus has some dependencies to other external features like Eclipse GEF or the Equinox framework, it is necessary to use the target-platform definition.
This definition is provided via the "target-platform.target" file and can be found in the bundle/project called "de.uniol.inf.is.odysseus.common.feature". Open this file and click "Set as target platofrm" to use this as your target platform. Notice, the target platform is valid for your whole workspace (therefore we recommend to use a dedicated workspace for Odysseus development).
You can use CRTL-SHIFT-R to search for the target platform
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):
- Odysseus Server.product - (located in de.uniol.inf.is.odysseus.server.starter) - This is just a server-based instance of Odysseus (without any GUI) which can be used e.g. via a webservice.
- Odysseus Studio 2 (Client).product - (located in de.uniol.inf.is.odysseus.client.starter) - This is only the client part (GUI), which tries to connect to a Odysseus via webservice.
- Odysseus Studio 2 (Monolithic).product - (located in de.uniol.inf.is.odysseus.monolithic.feature) - This combines server and client into a single product and adds some additional bundles that only work in such a monolithic combination.
For the first time, 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 his password is "manager", the tenant can be left empty. Now Odysseus should be up and running.
In some cases there is a message like:
This is due changes in the console for a new RCP version and can typically be ignored.
Since Odysseus is an OSGi based application it is devided into several bundles (the bunch of projects you checked out and imported before). To keep the overview of all bundles, they are combined to features. Each feature reflects a special functionality of Odysseus. thus, we have a core.feature that encapsulate all minimal needed bundles or the studio.feature that contains all bundles for the RCP aka GUI of Odysseus (what we call Studio).
The combination of several features is called a "product" - which should be runnable. The section above, for example, lists four products that combine different sets of features.
The core feature is necessary, because it contains all fundamental functions for Odysseus.
See Adding features to products how to add a new Feature to an existing product.
Odysseus comes with the Simple Logging Facade for Java (SLF4J). To use logging add the
de.uniol.inf.is.odysseus.slf4j bundle. In this bundle you can find the log4j.properties to configure the logging behaviour.
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: https://www.lonecpluspluscoder.com/2017/10/08/installing-other-versions-of-the-java-jdk-via-homebrew/