Variants of Installing the OTDT
This page explains the different variants for downloading and installing the
Object Teams Development Tooling. For an easy start with Object Teams we
recommend the full binary installation. Other options are provided to either
save bandwidth or to re-use an existing Eclipse installation in order to save disk space etc.
It is also possible to only install OT/Equinox without the Development Tooling
for Object Teams.
Full Binary Installation
Download size: approx. 130MB
This is the easiest way of installing the OTDT.
Steps to perform |
---|
- Download the appropriate zip file for your platform, currently either of
- win32
- linux-gtk
- macosx-carbon
- solaris-gtk
- Unpack the zip file in a directory of your choice. Unpacking will create a new directory called
eclipse-otdt-1.1.X
- Within the new directory execute the command
eclipse ,
perhaps passing regular Eclipse parameters like -clean or
-vmargs -Xmx512m
|
Install OT/Equinox only
Download size: approx. 700kB
This model only prepares an existing Eclipse installation to host aspect plug-ins
written in ObjectTeams/Java.
Steps to perform |
---|
- Download the OT/Equinox zip file
otequinox-1.1.X.zip
- Preferably unpack the zip file into a fresh installation of Eclipse.
Make sure the target directory for unpacking is the one containing the folders
features and plugins and the eclipse executable
(on windows: eclipse.exe ).
Please also make sure that the existing Eclipse installation matches exactly
the version that the OTDT was built upon (as of OTDT 1.1.9: Eclipse 3.3.2).
- For the first start of Eclipse pass the argument
-clean .
- If Eclipse has been run before from this installation and if OT/Equinox does
not start successfully you may have to remove cached configuration information
under
eclipse/configuration/org.* .
|
This kind of installation will not change the behavior of an existing Eclipse
installation.
It only enables Eclipse to run plug-ins written in ObjectTeams/Java.
In order to validate the installation of OT/Equinox, open the dialog
Help > About Eclipse SDK > Plug-in Details and find the plug-in
org.eclipse.ui.workbench
. In the "Version" column you should see
the additional string
*** OT-adapted by:
* org.objectteams.eclipse.transformer.example
Background information |
If you'd like to know what's happening, here is the list of files being installed
and their respective purposes:
plugins/org.objectteams.otequinox_1.1.X.jar
- The plug-in providing the extension point
org.objectteams.otequinox.aspectBindings where all aspect plug-ins register.
This plug-in manages the dependencies between aspect plug-ins and the base plug-ins which they adapt.
plugins/org.objectteams.eclipse.transformer.hook_1.1.X.jar
- A fragment for the Equinox framework. It installs the byte code transformers which
perform the load-time byte-code weaving for connecting aspect plug-ins with their base classes.
plugins/org.objectteams.otdt.pde.core.lib_1.1.X.jar
- Another fragment for the Equinox framework. It hosts the actual byte-code weaver and additional library classes required to run Object Teams programs.
configuration/config.ini
- Announces the above fragments and hooks to the Equinox framework.
If you have made modifications to the config.ini file you may need to manually
merge both files. Look for the tag #{ObjectTeams within the config.ini
shipped with OT/Equinox.
plugins/org.objectteams.eclipse.transformer.example_1.1.X.jar
- This tiny aspect plug-in adapts the "Plug-in Details" dialog of Eclipse in order to
display which installed plug-ins are currently adapted by an aspect plug-in.
These small modules implementing OT/Equinox must be installed into the actual Eclipse
installation directory, because
the above mentioned fragments must be located in the same directory as the equinox bundles,
which they collaborate with.
|
Install/upgrade the OTDT using the update manager
Download size: approx. 10MB
If you have previously installed the OTDT, the easiest way to upgrade to a newer version
is by opening the product configuration: Help > Software Updates > Manage Configuration.
Select the OTDT, click scan for updates and follow the instructions. That's all.
Alternatively, if you have successfully installed OT/Equinox (see above), you may use the update manager also for first-time installation of the
OTDT. During this process you may choose to install the OTDT as an extension.
This means the same Eclipse installation can be used with and without the OTDT feature.
This way each user can easily use different extensions.
Steps to perform |
---|
- Open the update manager using Help > Software Updates > Find and Install... > Search for new features to install ...
- In the offered list you should see "Object Teams Updates", select it and click Finish.
Otherwise enter a new remote location:
Name: | OTDT-updates |
URL: | http://www.objectteams.org/distrib/otdt-updates |
and click Finish
- Select the "Object Teams Development Tooling 1.1.X and follow the wizard.
- Before clicking Finish you may want to select Change Location ... then
Add Location.. and create a new directory for installing the OTDT extension.
- Click Finish and confirm to install the feature.
|
Manually install the OTDT
These variants are not recommended, they are listed only for
completeness.
Download size: approx. 10MB
A zip file of the OTDT feature can be installed manually on top of an existing
Eclipse installation.
There are two variants to this:
- A. (monolithic)
- Modify an existing Eclipse installation. After that it will not be possible to use this installation without the OTDT. The only advantage over a full binary installation might be in reducing the size of the download from
www.objectteams.org
.
- B. (extension)
-
If you have successfully installed OT/Equinox (see above), you may install the OTDT
as an extension. This means the same Eclipse installation can be used with and without
the OTDT feature. This variant requires manual work at the file level.
Extensions are selected in the Eclipse installation directory.
After installing OT/Equinox, it is much easier to use the update manager instead of this method.
Steps to perform |
---|
- Download the platform independent feature zip file
otdt-1.1.X-feature.zip (the same as mentioned above).
Please also make sure that the existing Eclipse installation matches exactly
the version that the OTDT was built upon (as of OTDT 1.1.9: Eclipse 3.3.2).
|
- Variant A.
|
- Unpack the feature into an existing installation of Eclipse (preferrably freshly installed). Make sure the target directory for unpacking is the one containing the folders
features and plugins and the eclipse executable
(on windows: eclipse.exe ).
|
- Variant B.
|
- Unpack this file in an extension location of your choice to obtain the following structure:
myextensionlocation (directory)
eclipse (directory)
.eclipseextension (empty file)
plugins (directory with several files and sub-directories)
features (directory with one sub directory: org.objectteams.otdt_1.1.X)
configuration (directory with one file: config.ini)
The items printed in blue have to be created manually, those printed in black are created
by unpacking the zip file. Instead of myextensionlocation you may choose any name, all other names must be used exactly as specified.
- Within the Eclipse installation that has been prepared for OT/Equinox create the following
file:
links/org.objectteams.otdt.link
which should contain this line of text:
path=<absolute path to>/myextensionlocation
Please note that within this file a "/" must be used as the path separator,
even on windows platforms.
|
- For the next start of Eclipse pass the argument
-clean .
- If Eclipse has been run before from this installation and if the OTDT does
not start successfully you may have to remove cached configuration information
under
eclipse/configuration/org.* .
|
Installing and using the command line compiler
The command line compiler can be downloaded as a single jar file called
ecotj_1.1.X.jar
.
The compiler can be run by the following command:
java -jar ecotj_1.1.X.jar arguments
|
Use -help
as the argument to see the list of options.
Running OT/J programs outside Eclipse is slightly more complicated.
We have script files which hide all details, however, configuring these
scripts is currently not automated. Please ask us via the
otj-users mailing list, if you want to run
OT/J programs from the command line.