Versions Compared

Old Version 14

changes.mady.by.user Kanchana Welagedara

Saved on

compared with

New Version 15

changes.mady.by.user Karthiga Ratnam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{scrollbar}

Anchor
top
top

First step on Deployment plans for

...

Geronimo v1.1

...

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 (f)First step on to first step in Geronimo v1.1 deployment plans which with cover ( a ) very simple samples( sample).Upcoming,(n)Next .
The next step of deployment plans( plan ) will be ready for users soon, which will provides( provide ) you ( with )on complex and advance samples.This first steps( step ) will help (for -delete)
for beginners of ( Apache Geronimo v1.1 )apache geronimo V1.1 to play with it( get an insight).

Apache Geronimo

...

v1.1 Deployment Plans

...

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

...

It is assumed that you have installed the either (T)tomcat Tomcat or the (J)jetty Jetty version of Geronimo ( v1.1)V1.1 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)

...

Deploying and Undeploying Helloworld sample.

This section will cover (best to put them as bulleted points)to understand how the 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 (A)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(e) paste the following code for ( with ) the "HelloWorld.jsp" in it.

...

4.Create a new folder called WEB-INF inside the app-home (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.1 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> directcory( directory).

No Format
borderStylesolid
titlegeronimo-web.xml
<?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>HelloWorld</dep:artifactId>
      <dep:version>1.1</dep:version>
      <dep:type>war</dep:type>
    </dep:moduleId>
  </dep:environment>

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

</web-app>

7.Open up(delete -up) a another new text file save it in <app_home\WEB_INF> directory and name it as "web.xml"
8.Copy and P(p)aste 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.

No Format
bgColor#000000
borderStylesolid
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.

...

No Format
bgColor#000000
borderStylesolid
java -jar deployer.jar --user system --password manager deploy <app_home>/HelloWorld.war

12.For the (delete -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

...

This section will cover Geronimo ( v1.1)V1.1 deployment plan for the (delete - a) a simple helloworld simple helloworld ejb.
Here is the folder structure for the above simple application.Sample Application is available to download here
HelloWorld ejb Sample

...

No Format
borderStylesolid
titleejb-jar.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ejb-jar PUBLIC "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN" "http://java.sun.com/dtd/ejb-jar_2_0.dtd">
<ejb-jar>
  <enterprise-beans>
    <session>
      <ejb-name>HelloBean</ejb-name>
      <home>org.geronimo.ejbsample.HelloHome</home>
      <remote>org.geronimo.ejbsample.HelloObject</remote>
      <ejb-class>org.geronimo.ejbsample.HelloBean</ejb-class>
      <session-type>Stateless</session-type>
      <transaction-type>Container</transaction-type>
    </session>
  </enterprise-beans>
  <assembly-descriptor>
    <container-transaction>
      <method>
        <ejb-name>HelloBean</ejb-name>
        <method-name>*</method-name>
      </method>
      <trans-attribute>Required</trans-attribute>
    </container-transaction>
  </assembly-descriptor>
</ejb-jar>

Geronimo ( v1.1 )V1.1 deployment plan for the above sample

No Format
borderStylesolid
titleopenejb.jar
<openejb-jar xmlns="http://www.openejb.org/xml/ns/openejb-jar-2.1">
  <dep:environment xmlns:dep="http://geronimo.apache.org/xml/ns/deployment-1.1">
    <dep:moduleId>
      <dep:groupId>org.geronimo.</dep:groupId>
      <dep:artifactId>ejbsample</dep:artifactId>
      <dep:version>1.0</dep:version>
      <dep:type>car</dep:type>
    </dep:moduleId>
    <dep:dependencies/>
    <dep:hidden-classes/>
    <dep:non-overridable-classes/>
  </dep:environment>
  <enterprise-beans>
    <session>
      <ejb-name>HelloBean</ejb-name>
      <jndi-name>org.geronimo.ejbsample.HomeBean</jndi-name>
    </session>
  </enterprise-beans>
</openejb-jar>

Steps to

...

deploying the sample

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

(1. The sample can be built from scratch using the build.xml and editing the geronimo_home as your directory. Obtain the helloworld-ejbs.jar from the dist directory and use the Geronimo web console. Browse for the helloworld-ejbs.jar file and click on the Install button.

2.Use the following command line code to deploy the application.) The user either can build the sample from the begining using the build.xml by editing the required geronimo_home as your relevant or directly get the helloworld-ejbs.jar from the "dist" directory for the direct deployment.Geronimo wen (web) console can be used for the direct deployment,what all you have to do is browse to the hellowolrd-ejbs.jar file and click the button install.Otherwise use the following command line option to deploy the application.

Code Block
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.
 
 No Format
bgColor#000000
borderStylesolid
< <app-home>/org/geronimo/ejbsampleclient> >java HelloWorld


 You will see the "Hello world" print on your command line
 
 No Format
bgColor#000000
borderStylesolid
  HelloWorld/org/geronimo/ejbsampleclient>
  Hello World!

*Image needed to be upload.
Deploying the EAR Application On Geronimo 
...
 v1.1
...
This sample application gives you an overview of basic steps to deploy an ear application in (G)geronimo V1EAR application in Geronimo v1.1(v1.1)
 Though this is a simple application it helps new users to understand the basics of GeronimoV1.1 (Geronimo 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 folder structure of it.( The following diagram depicts the folder structure.)
 Code Block
java
java
     HelloWorldEar
                |_src
                |    |_HelloWorld.java
                |_web
                |    |_index.jsp
                |_build
                |       |_src
                |      |    |_HelloWorld.class
                |      |_ear
                |      |  |_META_INF
                |      |  |     |_application.xml
                |      |  |     |_geronimo-application.xml
                |      |  |_helloworld.war
                |      |
                |      |_war
                |      |     |_WEB-INF
                |      |     |      |_classes
                |      |     |      |_web.xml
                |      |     |      |_geronimo-web.xml
                |      |     |_index.jsp
                |      |          
                |      |_deplomentdescriptors
                |                     |_application.xml
                |                     |_geronimo-application.xml
                |                     |_web.xml
                |                     |_geronimo-web.xml
                |_build.xml
                |_helloworld.ear


(The ) HelloWorldEar application('s ) contents ( content ) can be described as follows ((smile):-
  • src-HelloWorld servlet
  • web-JSP
  • build -where all the build out puts ( outputs ) go and it contents ( 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 and if somebody want to run this build file it's required to ,change the class paths and (geronimo_home)Geronimo Home <geronimo_home> as relevant to your environment.
  • helloworld.ear - This is the final distribution ( of )for the application and it will ( be created ) 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
...
 No Format
borderStylesolid
titleweb.xml
<?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>code
      <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>
{code}

Here is the geronimo-web.xml for the above warWAR module.
{noformat:borderStyle=solid}
<?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>

Direct The (delete - the) direct deployment can be done using the GeronimoV1.1(Geronimo v1.1 ) web Web console or else application can be deployed using the following command.
 No Format
bgColor#000000
borderStylesolid
java -jar <geronimo-home>/bin/deployer.jar deploy <app-home>helloworld.ear 

Deploying a J2EE Connector resources archive (RAR) with 
...
Geronimo v1.1
...
 In this This section will describe the deployment plan for RAR application with Geronimo ( v1.1)V1.1.The base of this sample has been ( borrowed )barrowed and modified from User Guide.(Migration to Apache Geronimo-JBoss to (G)geronimo 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 only(delete - only) two functions:
    • Lists 
     name(s) 
    • 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.
...
 No Format
borderStylesolid
titlera.xml
<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 (Geronimo v1.1 ) deployment plan 
 No Format
borderStylesolid
titlegeronimo-ra.xml
<connector version="1.5" xmlns="http://geronimo.apache.org/xml/ns/j2ee/connector-1.1">
  <dep:environment xmlns:dep="http://geronimo.apache.org/xml/ns/deployment-1.1">
    <dep:moduleId>
      <dep:groupId>com</dep:groupId>
      <dep:artifactId>ibm</dep:artifactId>
      <dep:version>j2g</dep:version>
      <dep:type>jca.rar</dep:type>
    </dep:moduleId>
    <dep:dependencies/>
    <dep:hidden-classes/>
    <dep:non-overridable-classes/>
  </dep:environment>
  <resourceadapter>
    <outbound-resourceadapter>
      <connection-definition>
        <connectionfactory-interface>com.ibm.j2g.jca.connector.FileRetrieverConnectionFactory</connectionfactory-interface>
        <connectiondefinition-instance>
          <name>FileRetriever</name>
          <!--The following path refers to the Geronimo home directory-->
          <config-property-setting name="RepositoryPath">..</config-property-setting>
          <connectionmanager>
            <no-transaction/>
            <no-pool/>
          </connectionmanager>
        </connectiondefinition-instance>
      </connection-definition>
    </outbound-resourceadapter>
  </resourceadapter>
</connector>

...
    • Defines the FileRetriever name which looks up for (delete-for) the resource adapter factory.
    • Specifies that neither transactions nor connection pool(s) pools are supported.
    • Provides ( the ) value of the repository path configuration parameter.
...
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)geronimo-home matchs (matches) <geronimo_home> matches your environment.
Next step is the deploying the rar RAR application with Geronimo.
 As stated in the previous examples user will have two choices of deploying an application with geronimo 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 RAR 
 
 No Format
bgColor#000000
borderStylesolid
java -jar <geronimo_home>/bin/deployer.jar --user system --password manager deploy meta/geronimo/jca-plan.xml jca.rar


 
 No Format
bgColor#000000
borderStylesolid
java -jar <geronimo_home>/bin/deployer.jar --user system --password manager deploy jca.war

 No Format
bgColor#000000
borderStylesolid
Insert the out put


 Once the JCA application is deployed, open a Web browser and access the following URL:
 http://localhost:8080/jca
Deploying an J2EE client application archive (JAR) with Geronimo 
...
v1.1