HomeDocumentation > Developing > Development environment > Installing Geronimo Eclipse Plugin

We will be using Eclipse Galileo and Sun JDK 6.0+ for the illustration. Geronimo Eclipse Plugin (GEP) can be installed using the following options:

This page describes how to install the current release of the GEP (GEP 2.2). For information about installing previous releases, see this page.

Note that with v2.2, the v2.2 Geronimo server adapter feature provides server adapters for the v1.1.x, v2.0.x, v2.1.x and v2.2 Geronino servers. The reason for supporting v1.1.x server is to make v1.1.x server adapter compatible with latest version of eclipse. But since Geronimo 1.1 did not officially support JDK 6, it's not recommended to use v1.1.x server adapter with JDK 6.See the requirement in GERONIMODEVTOOLS-578.

If you plan to upgrade GEP to the latest version, you have to uninstall the existing one from your Eclipse first. See Uninstalling GEP for more details.

Prerequisites

Sun JDK 6.0 can be downloaded from Sun's J2SE 6.0 Downloads site. The Eclipse IDE for Java EE Developers can be downloaded from the Eclipse Downloads site. Download and extract the Eclipse IDE for Java EE Developers archives to a directory of your choice (for e.g. C:\eclipse). The archive will be extracted to a directory named eclipse under the directory you specified (for e.g. C:\eclipse\eclipse), referred to as <ECLIPSE_HOME> from now on. Make sure that the JDK in the PATH is Sun JDK 6.0. Launch Eclipse by running <ECLIPSE_HOME>/eclipse.

To install the Geronimo server, download the Geronimo 2.2 server from Apache Geronimo downloads and extract the archive to a directory of your choice (for e.g. C:\g). The archive will be extracted to a directory geronimo-tomcat6-javaee5-2.2 (for e.g. C:\g\geronimo-tomcat6-javaee5-2.2) or geronimo-jetty6-javaee5-2.2 depending on whether you downloaded Geronimo 2.2 distribution with Tomcat or Jetty as the web container. We will refer to this directory as <GERONIMO_HOME> from now on.

Installing GEP within WTP

  1. Once you have all the Prerequisites installed, launch Eclipse from <ECLIPSE_HOME>/eclipse.By default Eclipse will be launched with Java EE perspective.
  2. Select the Servers tab as shown in the figure and select New->Server.





  3. On the next screen select Download Additional Server Adapters.





  4. Select Geronimo V2.2 Server Adapter and select Next.





  5. Accept the license agreement and select Finish.





  6. Next screen will ask for confirmation. Select OK. Once done Geronimo V2.2 server adapter will be downloaded and installed.





  7. Once the adapter is installed you will be prompted to restart the server. Select Yes.




From version 3.4, Eclipse adopted a new update manager called P2. The update manager can't uninstall plug-ins that isn't installed by P2. As a result, with this method, GEP can't be uninstalled by eclipse update manager in eclipse 3.4. See Bug245469 for details.

Installing GEP using Eclipse update manager

A video desktop demonstration of Installing the Apache Geronimo Eclipse Plugin with the Eclipse Update Manager is available.

  1. Once you have all the prerequisites installed. Launch Eclipse from <ECLIPSE_HOME>/eclipse. By default Eclipse will be launched with Java EE perspective.
  2. Select Help->Software Updates.. from the menu.





  3. On the next screen click Add.




  4. Copy and paste the following site to Add Site window and Select OK.
  5. Expand http://apache.org/dist/geronimo/eclipse/updates/. Select Geronimo v2.2 Server Adapter v2.2 and click Next.





  6. Wait until Eclipse finish resovling the requirements and dependencies. Review the details and click Finish.



  7. Review the license and accept the agreement.



  8. You have to wait a few seconds while Eclipse resolves dependencies.





  9. Select the items that you trust and select OK. You can review the details of these certificates by clicking on details.





  10. Once GEP is installed you will be prompted to restart. Select Yes.

Manual Installation

Using updatesite.zip

  1. Download the package geronimo-eclipse-plugin-2.2-updatesite.zip from http://apache.org/dist/geronimo/eclipse/2.2.0/.
  2. Once done, extract the package into a directory on your machine.
  3. Follow the instructions in Installing GEP using Eclipse update manager section. When adding a an update site in step 5, choose Local, and navigate to the directory where you unzipped the updatesite.zip package in the previous step.

Using deployable.zip

  1. Download the package geronimo-eclipse-plugin-2.2-deployable.zip from http://apache.org/dist/geronimo/eclipse/2.2.0/.
  2. Once done, extract the package into your eclipse installation directory. For Ganymede and Galileo, extract to eclipse/dropins directory. You may get a prompt regarding file replacement. Select All.
  3. Restart eclipse with the -clean option.

Verify GEP installation

  1. Select Help->About Eclipse Platform.





  2. You can see a G icon in the About Eclipse Platform. This confirms the successful installation of GEP. Click the icon.





  3. On the next screen you can view details- License, Plug-in-Details and set the Columns of the table being displayed.


Uninstalling GEP

You can cleanly uninstalled GEP only if you have installed it cleanly. To do so, install your GEP by using Eclipse update manager. If your GEP was installed within WTP, reinstall it with Eclipse update manager to update some meta information so that a clean uninstallation can be preformed.

You can uninstall GEP by selecting either of the followings:

  • Help->Install New Software-> What is already installed?
  • Help->About Eclipse->Installation Details
Uninstall does not work well on Ganymede, especially for GEP. It will uninstall GEP, but then you can't reinstall it, as it doesn't really get uninstalled. The only way to reinstall GEP in Ganymede is to reinstall Ganymede itself! See Eclipse Bugzilla 244935 for details, and hopefully a fix soon!