Page Created : GMOxDOC22 : Fast and easy development

Fast and easy development has been created by Ying Tang (Oct 14, 2008).

Content:

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 st= art guide for developers is organized in the following sections:

Getting the s= oftware

The Geronimo Eclipse Plugin (GEP) requires the following prerequisite so= ftware (all of which is platform specific):

Sun JDK 5.0 (J2SE 5.0)
Eclipse IDE for Java EE Developers

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 a= rchives to a directory of your choice (for e.g. C:\eclipse). The archive w= ill be extracted to a directory named eclipse under the directory you speci= fied (for e.g. C:\eclipse\eclipse), referred to as <eclipse_home><= /b> from now on. Make sure that the JDK in the PATH is Sun JDK 5.0. Launc= h 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, downloa= d the Geronimo 2.1.1 server from http://www.apache.org/dist/geronimo/ 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 Tomca= t or Jetty as the web container. We will refer to this directory as <= ;geronimo_home> from now on.

= Installing Geronimo Eclipse Plugin

The Geronimo Eclipse Plugin (GEP) can be installed using the following o= ptions:
=09
Using WTP
=09
Using Eclipse Update Manager
=09
Manual Installation

Install GEP U= sing WTP
The GEP can be installed directly from within WTP while defining a serve= r runtime. Follow the steps below to install GEP:
=09
Launch Eclipse by running <eclipse_home>/eclipse.
=09
Launch the Define a New Server dialog using one of the follow= ing: =09
=09=09
From the Servers view in the Java EE Perspective: <= b>Right-click, New, Server.
=09=09
From any Perspective: Select File, New, Other, Server
=09
=09
=09
Click on the Download additional server adapters link.
=09
In the Install New Server Adapter dialog, select Geronimo = v2.1 Server Adapter and click Next.
=09
Read and accept any License Agreements and click Finish. Cli= ck OK to continue installation.

This will download and install the GEP. The Progress view will d= isplay the installation status. Once the installation is completed, restar= t Eclipse. Define a New Server dialog will now show an Apache Ger= onimo v2.1 Server option under Apache.

Unable to render embedded objec= t: File (Fig04-Define-New-Server-2.gif) not found.

= Install GEP Using Eclipse Update Manager
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:
=09
Launch Eclipse by running <eclipse_home>/eclipse.
=09
Open the Eclipse Update Manager as follows: =09
=09=09
Select Help, Software Updates, Find and Install<= /b>.
=09=09
Select Search for new features to install and click Nex= t.
=09
=09
=09
Create a Eclipse Remote Update Site as follows: =09
=09=09
Click the New Remote Site... button.

Unable to render embedded objec= t: File (Fig06-NewUpdateSite.gif) not found.

=09=09
Type Geronimo Eclipse Update Site (or other suitable unique name)= in the Name field.
=09=09
Type the URL of the Geronimo Eclipse Update site http://www.apache.org/d= ist/geronimo/eclipse/updates in the URL field.
=09=09
Click OK.
=09
=09
=09
Select only the Geronimo Eclipse Update Site in the Sites to include= in search selection box and click Finish.
=09
Select a mirror and click OK if prompted to do so.
=09
In the Search Results, expand Geronimo Eclipse Update Site= and Geronimo WTP Server Adapters.
=09
Select Geronimo Core Feature 2.1.0 and Geronimo v2.1 Serve= r Adapter 2.1.0 and click Next.
=09
Read and accept any license agreements and click Next.
=09
Click Finish to download the selected features.
=09
Click Install All.
=09
Click Finish to complete the installation.
=09
Click Yes to restart Eclipse for the changes to take effect.<= /li>
Manual I= nstallation of GEP
Download the GEP 2.1 from http://www.apache.org/dist/geronimo/eclipse/. C= lose Eclipse if it is already running. Extract the archive to <eclip= se_home>. Launch Eclipse by running <eclipse_home>/eclipse= -clean.

The definitive and current version of the GEP installation instructions = may be found here: How to install Geronimo Eclipse Plugin v2.1.2.

Important
If you choose to = manually install the GEP first ensure that the Eclipse installation (that y= ou plan to unzip into) does not already contain the GEP features and plugin= s. If it does, you must first manually uninstall them all. Otherwise, Eclip= se will get confused with multiple versions of the same plugin(s) and featu= re(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).

Verify GEP= Installation

To verify that the GEP installation has been successful, start your new = Eclipse installation and from the workspace select "Help --> About Eclip= se Platform". In the panel that appears you will see anywhere from 4-6 Ecli= pse icons representing the various Eclipse projects and/or components insta= lled. 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 correct= ly, and you can confidently continue to the next step.=20

Unable to render embedded object= : File (Verify-GEP-Icon.gif) not found.

Defini= ng a New Server Runtime

Follow the steps below to define a new Geronimo v2.1 Server Runtime:

=09
Launch the Define a New Server dialog using one of the follow= ing: =09
=09=09
From the Servers view in the Java EE Perspective: Right= -click, New, Server.
=09=09
From any Perspective: Select File, New, Other, Server.
=09
=09
=09
Select Apache Geronimo v2.1 Server and click Next. =09
Select a 5.0 JRE (click Installed JREs to add any new JREs an= d return to this dialog once done).
=09
If you already have Geronimo v2.1 installation that you want to use = with GEP, enter the directory name or browse to <geronimo_home> and click Next. Skip the next three steps and go to selecting sou= rce archive.
=09
Enter a directory for Application Server Installation Directory, under Download Options select the web container and click Dow= nload and Install.
Important
The directory specif= ied for Application Server Installation Directory must exist in orde= r to select Download Options.
=09
Click OK for Install Confirmation. This will install the sel= ected Geronimo v2.1 server and fill the Application Server Installation = Directory field accordingly.
=09
Click Next.
=09
Select the location of the archive containing Geronimo source and cl= ick Next. This is required only if you intend to debug into Geronim= o source code.
=09
Modify Hostname, Administrator Id, Administrator pa= ssword, Web Connector port and RMI Naming port if necessa= ry and click Finish. Normally you will not need to change the defau= lt values for these fields for a newly installed Geronimo 2.1 server.

This completes defining a new Geronimo 2.1 Server runtime. The newly ad= ded server will appear in the Servers view. The server can be start= ed by selecting the server and clicking on the Start server button.

Unable to render embedded objec= t: File (Fig09-Servers-View.gif) not found.

Package = your applications

If you do not have your application already in the Eclipse workspace, im= port the application archive using the following steps:

=09
Select File, Import to launch the Select dialog= .
=09
Based on your application type, select as given below: =09
=09=09
For Web application, Select Web, WAR file.
=09=09
For EAR application, Select J2EE, EAR file.
=09=09
For EJB application, Select EJB, EJB JAR file.
=09
=09
=09
Click Next. =09
Type the name of the WAR file or select the WAR file by clicking on = Browse, enter/edit the Project Name and select Apache Ger= onimo v2.1 Runtime as Target Runtime.
=09
Click Finish to complete the import.
The imported application can be viewed in the Project Explorer vi= ew. 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 resource= s used by your application.
Deploy you= r application
To deploy the application on Geronimo, follow the steps below:
=09
In the Servers view, Right-click on Apache Geronimo= v2.1 Server at localhost and select Add and Remove Projects. =09
In the Add and Remove Projects dialog, select the project und= er Available projects and click on Add button. The project w= ill now be listed under Configured projects.
=09
Click Finish.

The application will be deployed when the server is Started or a Publish= is invoked.
Run your appl= ication
In order to run the application follow the steps below:
=09
In the Project Explorer view, Right-click on the proje= ct, select Run As, Run on server.
=09
Select Choose an existing server and select Apache Geronim= o v2.1 server at localhost.
=09
Click Finish.

This will start the server if it not already started and run the applica= tion. The application's welcome page will open in a browser inside Eclipse= .
Remaining steps are based on a web application.

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences