Page History

...

top

First step on Deployment plans for

...

Geronimo v1.

...

2

Introduction
Apache #Apache Geronimo v1.1 deployment 2 Deployment Plans
Work #Work out Deployment Plan Plans with Samples
(I will include the completed samples here)

-Deploying and Undeploying Simple HelloWorld (war module,web.xml,geronimo-web.xml)
-Deploying and Undeploying HelloWorld J2EE Samples(JAR containing EJB ,ejb-jar.xml,openejb.xml)
-Deploying and Undeploying JCA sample with Geronimo

Discussion#Discussion
Conclusion#Conclusion

Introductionintro

Every service,application , or resource in Geronimo is configured with an xml deployment plan.Deployment plans are the Geronimo version of the J2EE deployment descriptors. They are still XML files based on XML schemas and containing the configuration details for a specific application module. Via the deployment plans you can not only deploy application modules but also other configurations such as a security realm etc..This is the First step on to geronimoV1.1 first step in Geronimo v1.2 deployment plans which with cover very a simple samples.Upcoming Next sample.
The next step of deployment plans plan will be ready for user users soon, which will provides provide you on with complex and advance samples.This first steps step will help for the beginers of apache geronimo V1.1beginners of Apache Geronimo v1.2 get an insight.

Apache Geronimo

...

v1.

...

2 Deployment Plans

The following table illustrates the deployment descriptors name and file location for both standard J2EE and Apache Geronimo specific.

File	Standard Deployment Descriptors in the J2EE specification	Apache Geronimo specific Deployment plan
Web Application Archive (WAR)	web.xml under the WEB-INF directory	geronimo-web.xml
Enterprise Web application archive (EAR)	application.xml	geronimo-application.xml
J2EE Connector resources archive (RAR)	ra.xml	geronimo-ra.xml
J2EE client application archive (JAR)	client.xml	geronimo-application-client.xml
JAR containing EJBs	ejb-jar.xml under the META-INF directory	openejb-jar.xml

Work Out Deployment Plans with

...

Samples

Assumptions

It 's is assumed that you have installed the either tomcat Tomcat or the jetty Jetty version of Geronimo V1v1.1 2 successfully and it is working. Please find the further details to get the software and install it.(need to direct the link to Installation Guide and the User Guide)

Deployment plan for WAR Module

Deploying and Undeploying Helloworld sample.

This section will cover to understand understanding how the deployment plan works for each one of different application modules.
First let's have look at the simple "HelloWorld"example which creates a Web Application Archive (WAR) under the WEB-INF directory and has a geronimo-web.xml as the apache Apache Geronimo specific deployment Plan.

Here are the steps to understand the deployment plan for the "HelloWorld" Example
1.Create a folder in called <app_home> in your working directory
2.Open up a new text file and save it as "HelloWorld.jsp" in side the app_home directory
3.Copy and past paste the following code for with the "HelloWorld.jsp" in it.

...

4.Create a new folder called "WEB-INF" inside the app-_home directory.

5.Open up a new text file and save it as "geronimo-web.xml" (use simple letters) and this is the apache geronimo1.1deployment Apache Geronimo v1.2 deployment plan for this sample module.
6.Copy and paste the following xml code in that file and save it inside the <app_home\WEB-INF> directcorydirectory.

...

7.Open up a another new text file save it in <app_home\WEB_INF> directory and name it as "web.xml"
8.Copy and Paste paste the following xml code in it and save.

...

9.The next step is packaging the application.From a command line window change the directory to <app_home> and run the following command to package the HelloWorld application into a single .war file.

...

#000000solid jar

...

-cvf

...

HelloWorld.war

...

*

...

This will create a HelloWorld.war file in the <app_home> directory. The next step is to deploy this application.

10.User can use the preferable preferred deployment approach either command line or the Geronimo Web Console.
Here it describes how to use the command line.

11.Change directory to <geronimo_home>/bin and run the following command:
#000000solid java -jar deployer.jar --user system --password manager deploy <app_home>/HelloWorld.war

12.For the further instructions about deployment process please refer the Quick Start or Sample Applications working.The sample application code can be downloaded here.
HelloWorld web Sample

Access Hello World web sample
http://localhost:8080/hello

Deploying JAR containing Simple EJB application

This section will cover the write of GeronimoV1Geronimo v1.1 deployment plan for the a simple helloworld ejb.
Here is the folder structure for the above simple application.Sample Application is available to download here
HelloWorld ejb Sample

...

Here is the ejb-jar.xml for the above sample

...

GeronimoV1Geronimo v1.1 2 deployment plan for the above sample

...

Steps to

...

deploying the sample

There are two ways in which the sample can be deployed :-

1. The user either can build sample can be built from scratch using the build.xml by and editing the required geronimo_home as your relevant or directly get directory. Obtain the helloworld-ejbs.jar from the "dist" directory for and use the direct deployment. Geronimo wen console can be used for the direct deployment,what all you have to do is browse to the hellowolrdweb console. Browse for the helloworld-ejbs.jar file and click on the Install button install.Otherwise use .

2.Use the following command line option code to deploy the application.

...

Running the Client to test the HelloWorld

...

EJB service

...

org.geronimo.ejbsample.client.HelloWorld.java is the client code for the above application.Set the necessary class path to run client in your environment.

...

#000000solid <

...

<app-home>/org/geronimo/ejbsampleclient>

...

>java

...

HelloWorld

...

You will see the "Hello world" print on your command line

...

#000000solid HelloWorld/org/geronimo/ejbsampleclient>

...

Hello

...

World!

...

*Image needed to be upload.

Deploying the EAR Application On Geronimo

...

v1.

...

2

This sample application gives you an overview of basic steps to deploy an ear EAR application in geronimo V1.1Geronimo v1.2.
Though this is a simple application it helps new users to understand the basics of GeronimoV1Geronimo v1.1 specific deployment plan for an EAR and move on to work with complex applications. In this sample ,Servelts are used in the back end while JSP is used in the front end.
Following graft is shown The following diagram depicts the folder structure of it.

...

HelloWorldEar application contents can be described as follows

src-HelloWorld servlet
web-JSP
build -where all the build out puts go and it contents sub folders src ,war,ear,deploymentdescriptors.
build.xml-The build file is also attached in the source bundle and if somebody want to run this build file it's required to change the class paths and Geronimo Home as relevant to your environment.
helloworld.ear - This is the final distribution for the application and it will create at the root folder as shown.
Source code can be downloaded from here

HelloWorldEar EAR Sample

Here is the application.xml for the above application
application.xml

Code Block


<?xml version="1.0" encoding="ISO-8859-1"?>

<application>
<display-name>HelloWorldEar</display-name>
<module>
<web>
<web-uri>helloworld.war</web-uri>
<context-root>/hello</context-root>
</web>
</module>
</application>

Here is the Geronimo specific deployment plan geronimo-application.xml

geronimo-application.xml

...

The HelloWorldEar application's content can be described as follows:-

src-HelloWorld servlet
web-JSP
build -where all the build outputs go and it contains sub folders such as; src ,war,ear,deploymentdescriptors.
build.xml-The build file is also attached in the source bundle. In order to run this build file,change the class paths and <geronimo_home> as relevant to your environment.
helloworld.ear - This is the final distribution of the application and it will be created at the root folder as shown.
Source code can be downloaded from here

HelloWorldEar EAR Sample

Here is the application.xml for the above application

...

Here is the Geronimo specific deployment plan geronimo-application.xml

...

Here is the web.xml

...

Here is the geronimo-web.xml for the above WAR module.

...

Here is the web.xml

Code Block


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web-1.1">
  <dep:environment xmlns:dep="http://geronimo.apache.org/xml/ns/deployment-1.1">
    <dep:moduleId>
      <dep:groupId>geronimo</dep:groupId>
      <dep:artifactId>HelloWorldEar</dep:artifactId>
      <dep:version>1.1</dep:version>
      <dep:type>war</dep:type>
    </dep:moduleId>
  </dep:environment>

  <context-root>/hello</context-root>

</web-app>

Here is the geronimo-web.xml for the above war module.

Code Block


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web-1.1">
  <dep:environment xmlns:dep="http://geronimo.apache.org/xml/ns/deployment-1.1">
    <dep:moduleId>
      <dep:groupId>geronimo</dep:groupId>
      <dep:artifactId>HelloWorldEar</dep:artifactId>
      <dep:version>1.1</dep:version>
      <dep:type>war</dep:type>
    </dep:moduleId>
  </dep:environment>

  <context-root>/hello</context-root>

</web-app>

The direct deployment can be done using the GeronimoV1.1 web console or else application can be deployed using the following command.

Code Block
java -jar <geronimo-home>/bin/deployer.jar deploy <app-home>helloworld.ear

Deploying a J2EE Connector resources archive (RAR) with GeronimoV1.1

In this section will describe the deployment plan for RAR application with GeronimoV1.1.The base of this sample has been barrowed and modified from User Guide.(Migration to Apache Geronimo-JBoss to geronimo JCA migration.html)This sample contains a File Retriever JCA sample application it consists of two modules that, for this sample purposes, are deployed separately and not as a single EAR archive.
The first module is a simple file system resource adapter that conforms to the JCA architecture without any server-specific extensions. The adapter provides only two functions:

Lists name of files and directories located in a specific repository being a directory in the underlying file system.
Retrieves the content of one of the files.

The second module is a Web application that uses the adapter and provides online access to the files.

Input Image JSP<---------->FileRetriver

The user views a list of directories and files located in the repository and clicks a file to download it from the server. By default the resource adapter is configured so that the root directory of an application server is used as the repository.

Folder structure for the JCA sample is shown below.

Code Block
jca \|_src \|_meta \| \|_geronimo \| \|_geronimo-ra.xml \| \|_ra.xml \| \|_jca-plan.xml \|_web \| \|_WEB_INF \| \|_geronimo-web.xml \| \|_web.xml \|_jca.rar \|_jca.war

J2EE RAR Deployment Plan

ra.xml

Code Block


<connector xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee                             http://java.sun.com/xml/ns/j2ee/connector_1_5.xsd" version="1.5" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <display-name>FileRetriever</display-name>
  <vendor-name>IBM</vendor-name>
  <eis-type>File system</eis-type>
  <resourceadapter-version>1.0</resourceadapter-version>
  <resourceadapter>
    <outbound-resourceadapter>
      <connection-definition>
        <managedconnectionfactory-class>com.ibm.j2g.jca.connector.impl.FileRetrieverManagedConnectionFactory</managedconnectionfactory-class>
        <config-property>
          <description>Path to the directory being the file repository</description>
          <config-property-name>RepositoryPath</config-property-name>
          <config-property-type>java.lang.String</config-property-type>
        </config-property>
        <connectionfactory-interface>com.ibm.j2g.jca.connector.FileRetrieverConnectionFactory</connectionfactory-interface>
        <connectionfactory-impl-class>com.ibm.j2g.jca.connector.impl.FileRetrieverConnectionFactoryImpl</connectionfactory-impl-class>
        <connection-interface>com.ibm.j2g.jca.connector.FileRetrieverConnection</connection-interface>
        <connection-impl-class>com.ibm.j2g.jca.connector.impl.FileRetrieverConnectionImpl</connection-impl-class>
      </connection-definition>
      <transaction-support>NoTransaction</transaction-support>
      <reauthentication-support>false</reauthentication-support>
    </outbound-resourceadapter>
  </resourceadapter>
</connector>

J2EE RAR GeronimoV1.1 deployment plan

geronimo-ra.xml

...

Direct deployment can be done using the Geronimo v1.2 Web console or else application can be deployed using the following command.
#000000solid java -jar <geronimo-home>/bin/deployer.jar deploy <app-home>helloworld.ear

Deploying a J2EE Connector resources archive (RAR) with Geronimo v1.2

This section will describe the deployment plan for RAR application with Geronimo v1.2.The base of this sample has been borrowed and modified from User Guide.(Migration to Apache Geronimo-JBoss to Geronimo JCA migration.html)This sample contains a File Retriever JCA sample application it consists of two modules that, (for the purpose of this sample)for this sample purposes, are deployed separately and not as a single EAR archive.
The first module is a simple file system resource adapter that conforms to the JCA architecture without any server-specific extensions. The adapter provides two functions:

Lists names of files and directories located in a specific repository being a directory in the underlying file system.
Retrieves the content of one of the files.

The second module is a Web application that uses the adapter and provides online access to the files.

Image Added

The user views a list of directories and files located in the repository and clicks a file to download it from the server. By default the resource adapter is configured so that the root directory of an application server is used as the repository.

Folder structure for the JCA sample is shown below.

...

J2EE RAR Deployment Plan

...

J2EE RAR Geronimo v1.1 deployment plan

...

To deploy the adapter on Geronimo you also need a deployment plan specific to this server. Such a plan can be either named geronimo-ra.xml and be placed into the META-INF folder of the corresponding RAR archive, or can have any name and stay outside the archive. In the latter case, the path to the plan should be specified during the deployment of the resource adapter.
The deployment plan used by the sample application contains the repository path configuration parameter that may be updated before the deployment. Because of this, the jca-plan.xml file is not included in the RAR archive but it is placed into the <jca_home>/meta/geronimo directory instead. The content of this file is listed in the following example.

...

In this deployment plan the attribute <dep:moduleId> </dep:moduleId>segment specifies the unique name com/ibm/j2g/jca.rar used to identify the RAR module in Geronimo and that this module is deployed on the server as a separate component.
The descriptor also:

Defines the FileRetriever name which looks up the resource adapter factory.
Specifies that neither transactions nor connection pools are supported.
Provides the value of the repository path configuration parameter.

Building the sample Application.

In order to build the modules of the File Retriever JCA application you need to update the build.properties file and property such as <geronimo_home> matches your environment.

Next step is the deploying the RAR application with Geronimo.
As stated in the previous examples user will have two choices of deploying an application with Geronimo either Geronimo web console or command line.Here the command line option is described following.
From a command line, change directory to <jca_home> and type the following commands:
Deploying jca-plan.xml and RAR
#000000solid java -jar <geronimo_home>/bin/deployer.jar --user system --password manager deploy meta/geronimo/jca-plan.xml jca.rar
#000000solid java -jar <geronimo_home>/bin/deployer.jar --user system --password manager deploy jca.war

#000000solid Insert the out put
Once the JCA application is deployed, open a Web browser and access the following URL:
http://localhost:8080/jca

Child pages

Versions Compared

Old Version 2

New Version Current

Key

First step on Deployment plans for

Geronimo v1.

2

Introductionintro

Apache Geronimo

v1.

2 Deployment Plans

Work Out Deployment Plans with

Samples

Assumptions

Deployment plan for WAR Module

Deploying and Undeploying Helloworld sample.

Deploying JAR containing Simple EJB application

Steps to

deploying the sample

Running the Client to test the HelloWorld

EJB service

Deploying the EAR Application On Geronimo

v1.

2

Deploying a J2EE Connector resources archive (RAR) with GeronimoV1.1

Deploying a J2EE Connector resources archive (RAR) with Geronimo v1.2

Building the sample Application.

Deploying an J2EE client application archive (JAR) with Geronimo v1.2

Conclusion