...
This section describes how to set up Eclipse and Odysseus for developmentsdevelopment.
1. Prerequisites
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.: Newer versions than Oxygen currently don't work! Please use Eclipse Oxygen RCP RAP until we fixed the error. You can find it here: 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 detailsclient (you can use git from command line or with a tool of your choice)
2. Checkout Source Code
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 for with Odysseus:
...
Option 1 (preferred): Extending Odysseus with
...
New Plugins
Odysseus has a very large code base. To allow a much easier lightweight start, we provide a template project in our Bitbucket server. You should clone or fork this project and use it to add new plugins to this template. The template can be found here: https://git.swl.informatik.uni-oldenburg.de/projects/ODY/repos/odysseusrepotemplate/browse . When using git you should use the following command to clone Odysseus (Odysseus is based on submodules, so the flag recurse-submodules is necessary):. The template contains some standard products and the target platform as a submodule. The "--recurse-submodules" flag clones this submodule when cloning the repository. Alternatively, you can clone the submodule individually.
| Code Block | ||
|---|---|---|
| ||
git clone --recurse-submodules https://git.swl.informatik.uni-oldenburg.de/scm/ody/odysseusrepotemplate.git |
Remark: Because, because you are not allowed to push updates here, 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 | ||
|---|---|---|
| ||
git remote set-url origin <new url> |
...
Option 2:
...
With this method, you check out all the source code from Odysseus. The source code is publicly available via git (from a Bitbucket server):
...
| language | bash |
|---|
...
Extending an Existing Odysseus Plugin
You want to extend an existing plugin from Odysseus? 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: https://git.swl.informatik.uni-oldenburg.de/
...
projects . 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> |
...
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:
...