Example Eclipse Installers
Last modified 17:45 Friday June 21, 2002
These example Eclipse installers demonstrate how Eclipse-based products and
extensions are constructed and installed. These examples are made available by
IBM under the accompanying license (license.html
).
The examples consists of the following files.
readme.html
license.html (Example Eclipse
Installers License Agreement)
cpl-v10.html (Common Public License
v1.0)
eclipse-product-1.0.0.exe (pre-built product installer
- Windows executable)
eclipse-product-1.0.1.exe (pre-built product installer
- Windows executable)
eclipse-extension-1.0.0.exe (pre-built extension installer -
Windows executable)
eclipse-extension-1.0.1.exe (pre-built extension installer -
Windows executable)
install-project/ (InstallShield project files)
code/
...
data/
...
resources/
...
sample-site/ (example update site)
site.xml
(site manifest file)
...
Native Install Scenarios
The following steps cover the bases with native product and extension
installers (4 of 6). After each step we run the product to demonstrate that it
is functioning correctly. This walk covers:
- natively installing a product
- natively installing an extension into a product
- natively updating a product
- natively updating an extension
- uninstalling an extension
- uninstalling a product
Raw materials: 2 example product installers (v 1.0.0 and 1.0.1); 2
example extension installers (v 1.0.0 and 1.0.1); JRE
- install product 1.0.0
- install extension 1.0.0 and link to product
- install product 1.0.1 over top product
- install extension 1.0.1 over top extension
- uninstall extension
- uninstall product
Detailed steps
- Run eclipse-product-1.0.0 to install My Product version 1.0.0
- default location is fine
- this installer does not lay down a JRE; so copy a Sun or IBM 1.3 or
1.4 JRE to <install>/eclipse/jre/
- this installer does not "prime the pump"; do this manually
by creating a shortcut to eclipse.exe and adding -initialize as command
line option; launch once (it runs headless)
- Inspect the install
- assuming <product-install> is c:\Program Files\CompanyA\My
Product
- <product-install>/eclipse/
- 3 features; 36 plug-ins
- desktop shortcut called My Product
- Run My Product from desktop shortcut
- "My Product version 1.0.0" splash
- workbench window opens
- editor shows "Welcome to My Product"
- window icon is green dot
- window title is "Resource - My Product"
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.0;
Eclipse and My Product icons in bar below
- Feature Details dialog show 3 features: My Product 1.0.0, Eclipse Platform
2.0.0, and Eclipse Platform (Windows) 2.0.0
- exit workbench
- Run eclipse-extension-1.0.0 to install My Extension version 1.0.0
- default location is fine
- allow installer to search disk to find installed Eclipse-based
products
- select <product-install> for My Product from list
- Inspect the install
- assuming <extension-install> is c:\Program Files\CompanyB\My
Extension
- <extension-install>/eclipse/
- 1 feature; 1 plug-in
- new file
<product-install>/eclipse/links/com.example.companyB.myextensionfeature.link
- Run My Product from desktop shortcut
- "My Product version 1.0.0" splash (twice)
- workbench window opens
- dialog says "You have updates. Do you wish to open the update
manager now?"
- hit "Yes"
- configuration changes dialog shows pending changes - incoming feature
My Extension 1.0.0
- select all
- hit "OK" when it asks to restart
- "My Product version 1.0.0" splash
- Help -> About My Product
- main about dialog shows My Extension feature icon (cyan dot) in bar
below
- Feature Details dialog show 4 features: My Product 1.0.0, My Extension 1.0.0,
Eclipse Platform 2.0.0, and Eclipse Platform (Windows) 2.0.0
- exit workbench
- Run eclipse-product-1.0.1 to upgrade My Product from 1.0.0 to 1.0.1
- it recognizes that existing install of My Product is being upgraded to
1.0.1
- Inspect the install
- <product-install>/eclipse/
- 4 features; 37 plug-ins
- Run My Product from desktop shortcut
- "My Product version 1.0.0" splash (twice)
- workbench window opens
- dialog says "You have updates. Do you wish to open the update
manager now?"
- hit "Yes"
- configuration changes dialog shows pending changes - incoming feature
My Product 1.0.1
- select all
- hit "OK" when it asks to restart
- "My Product version 1.0.1" splash
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.1;
Eclipse, My Product, and My Extension icons in bar below
- feature dialog show 4 features: My Product 1.0.1, My Extension 1.0.0,
Eclipse Platform 2.0.0, and Eclipse Platform (Windows) 2.0.0
- exit workbench
- Run eclipse-extension-1.0.1 to upgrade My Extension from 1.0.0 to 1.0.1
- it recognizes that existing install of My Extension is being upgraded
to 1.0.1
- skip installing more links
- Inspect the install
- <extension-install>/eclipse/
- 2 features; 2 plug-ins
- Run My Product from desktop shortcut
- "My Product version 1.0.1" splash (twice)
- workbench window opens
- dialog says "You have updates. Do you wish to open the update
manager now?"
- hit "Yes"
- configuration changes dialog shows pending changes - incoming feature
My Extension 1.0.1
- select all
- hit "OK" when it asks to restart
- "My Product version 1.0.1" splash
- Help -> About My Product
- Feature Details dialog show 4 features: My Product 1.0.1, My Extension 1.0.1,
Eclipse Platform 2.0.0, and Eclipse Platform (Windows) 2.0.0
- exit workbench
- Uninstall My Extension
- Control panel; Add or Remove programs
- Remove "CompanyB My Extension Example 1.0.1"
- Inspect the install
- <extension-install> is gone
- new file
<product-install>/eclipse/links/com.example.companyB.myextensionfeature.link
is gone
- Run My Product from desktop shortcut
- "My Product version 1.0.1" splash (twice)
- workbench window opens
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.1;
Eclipse and My Product icons in bar below (My Extension icon is gone)
- Feature Details dialog show 3 features: My Product 1.0.1, Eclipse Platform
2.0.0, and Eclipse Platform (Windows) 2.0.0
- exit workbench
- Uninstall My Product
- Control panel; Add or Remove programs
- Remove "CompanyA My Product Example 1.0.1"
- Inspect the install
- <product-install>/eclipse/ is gone except for jre/ and
workspace/ and .config/
- desktop shortcut called My Product is gone
Update Manager scenarios
The above scenarios do not involve the Eclipse update manager
directly.
The following steps cover the bases with updating natively installed products
and extensions with the update manager. After each step we run the product to
demonstrate that it is functioning correctly. This walk covers:
- using the Eclipse update manager to update a natively installed product
- using the Eclipse update manager to update a natively installed extension
- using the Eclipse update manager to install a new extension/feature
- using the Eclipse update manager to update a extension/feature that it
installed
- using the Eclipse update manager to update the Eclipse Platform features
Raw materials: example product installer (v 1.0.0); example extension
installer (v 1.0.0); JRE; update site with product (v1.0.1); update site with
extension (v1.0.1); access to Eclipse Nevada test site.
- install product 1.0.0
- install extension 1.0.0 and link to product
- update product 1.0.1 via update manager
- update extension 1.0.1 via update manager
- update eclipse platform via update manager
- uninstall extension
- uninstall product
Detailed steps
- install My Product 1.0.0 and My Extension 1.0.0 as per above scenario
- Run My Product from desktop shortcut
- Help -> Software Updates -> Update Manager
- in Features Update view, navigate under My Computer to
the sample- site/ subdirectory
- locate and select "My Product version 1.0.1" from update site and update to
it
- notice that it knows to install the new version of product into
<product-install> by default
- say "OK" when it asks to restart
- "My Product version 1.0.1" splash
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.1;
Eclipse, My Product, and My Extension icons in bar below
- Feature Details Dialog show 4 features: My Product 1.0.1, My Extension 1.0.0,
Eclipse Platform 2.0.0, and Eclipse Platform (Windows) 2.0.0
- select "My Extension version 1.0.1" from update site and update
to it
- notice that it knows to install the new version of extension into
<extension-install> by default
- say "OK" when it asks to restart
- "My Product version 1.0.1" splash
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.1;
Eclipse, My Product, and My Extension icons in bar below
- Feature Deatils dialog show 4 features: My Product 1.0.1, My Extension 1.0.1,
Eclipse Platform 2.0.0, and Eclipse Platform (Windows) 2.0.0
- create a new site bookmark called "Nevada test site" for URL "http://update.eclipse.org/testUpdates"
- select "Eclipse Platform (Windows) 2.0.0.200206211024" or more
recent and
update it
- notice that it knows to install the new version of Eclipse platform
into <product-install> by default
- say "Cancel" when it asks to restart
- select "Eclipse Platform 2.0.0.200206211024" and update it (slow
due to 16MB download)
- say "OK" when it asks to restart
- "My Product version 1.0.1" splash
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.1;
Eclipse icon, My Product icon, My Extension icon, and Other Extension icon (purple dot)
in bar below
- feature dialog show 4 features: My Product 1.0.1, My Extension 1.0.1, Eclipse Platform
2.0.0.200206211024, and Eclipse
Platform (Windows) 2.0.0.200206211024
- at this point we are running all new code; only
<product-install>/eclipse/eclipse.exe and startup.jar have not been
replaced
- Uninstall My Extension
- Control panel; Add or Remove programs
- Remove "CompanyB My Extension Example 1.0.0"
- Inspect the install
- <extension-install> is gone [bug - uninstaller is leaving behind
files it didn't add]
- new file
<product-install>/eclipse/links/com.example.companyB.myextensionfeature.link
is gone
- Run My Product from desktop shortcut
- "My Product version 1.0.1" splash (twice)
- workbench window opens
- Help -> About My Product
- main about dialog shows My Product text and image version 1.0.1; My Extension icon is
gone
- feature dialog show 3 features: My Product 1.0.1, Eclipse Platform
2.0.0.200206211024, and Eclipse
Platform (Windows) 2.0.0.200206211024
- exit workbench
- Uninstall My Product
- Control panel; Add or Remove programs
- Remove "CompanyA My Product Example 1.0.0"
- Inspect the install
- <product-install>/eclipse/ is gone except for jre/ and
workspace/ [bug - installer not deleting all features/ and plugins/]
- desktop shortcut called My Product is gone