|Home > Documentation > Developer's guide > Quick start - fast and easy development|
The Geronimo Eclipse Plugin (GEP) provides integration between Geronimo and the Web Tools Platform (WTP). With this plugin, users will be able to use the features in WTP to create, deploy and debug applications on Geronimo. This Quick start guide for developers is organized in the following sections:
The Geronimo Eclipse Plugin (GEP) requires the following prerequisite software (all of which is platform specific):
Sun JDK 5.0 can be downloaded from Sun's J2SE 5.0 Downloads site. The Eclipse IDE for Java EE Developers can be downloaded in 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 5.0. Launch Eclipse by running <eclipse_home>/eclipse.
The Geronimo server can be installed using the Geronimo Eclipse Plugin, or optionally you may install the manually. To install it manually, download the Geronimo 2.1.1 server from http://geronimo.apache.org/downloads.html 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.1.1 (for e.g. C:\g\geronimo-tomcat6-javaee5-2.1.1) or geronimo-jetty6-javaee5-2.1.1 depending on whether you downloaded Geronimo 2.1.1 distribution with Tomcat or Jetty as the web container. We will refer to this directory as <geronimo_home> from now on.
The definitive and current version of the GEP installation instructions may be found here: How to install Geronimo Eclipse Plugin v2.1.7.
The Geronimo Eclipse Plugin (GEP) can be installed using the following options:
The GEP can be installed directly from within WTP while defining a server runtime. Follow the steps below to install GEP:
This will download and install the GEP. The Progress view will display the installation status. Once the installation is completed, restart Eclipse. Define a New Server dialog will now show an Apache Geronimo v2.1 Server option under Apache.
The GEP can also be installed via the Eclipse Update manager by creating a new remote site pointing to http://www.apache.org/dist/geronimo/eclipse/updates/. Follow the steps below to install GEP:
Download the GEP 2.1 from http://www.apache.org/dist/geronimo/eclipse/. Close Eclipse if it is already running. Extract the archive to <eclipse_home>. Launch Eclipse by running <eclipse_home>/eclipse -clean.
If you choose to manually install the GEP first ensure that the Eclipse installation (that you plan to unzip into) does not already contain the GEP features and plugins. If it does, you must first manually uninstall them all. Otherwise, Eclipse will get confused with multiple versions of the same plugin(s) and feature(s), and you may not get the results that are expected (i.e., you may in fact end up using an older version of the GEP).
To verify that the GEP installation has been successful, start your new Eclipse installation and from the workspace select "Help --> About Eclipse Platform". In the panel that appears you will see anywhere from 4-6 Eclipse icons representing the various Eclipse projects and/or components installed. You must also see the Geronimo icon as shown below. If not something has not been installed correctly. If the Geronimo icon does appear that is a very good indication that Eclipse and the GEP have been installed correctly, and you can confidently continue to the next step.
Follow the steps below to define a new Geronimo v2.1 Server Runtime:
The directory specified for Application Server Installation Directory must exist in order to select Download Options.
This completes defining a new Geronimo 2.1 Server runtime. The newly added server will appear in the Servers view. The server can be started by selecting the server and clicking on the Start server button.
If you do not have your application already in the Eclipse workspace, import the application archive using the following steps:
Remaining steps are based on a web application.
The imported application can be viewed in the Project Explorer view. The GEP will create a Geronimo specific deployment plan, in this case geronimo-web.xml under WebContent/WEB-INF, if one is not already present in the archive. You may need to edit the deployment plan to map any resources used by your application.
To deploy the application on Geronimo, follow the steps below:
The application will be deployed when the server is Started or a Publish is invoked.
In order to run the application follow the steps below:
This will start the server if it not already started and run the application. The application's welcome page will open in a browser inside Eclipse.