Return-Path: Delivered-To: apmail-geronimo-scm-archive@www.apache.org Received: (qmail 3477 invoked from network); 12 Dec 2005 05:29:01 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 12 Dec 2005 05:29:01 -0000 Received: (qmail 45799 invoked by uid 500); 12 Dec 2005 05:28:51 -0000 Delivered-To: apmail-geronimo-scm-archive@geronimo.apache.org Received: (qmail 45548 invoked by uid 500); 12 Dec 2005 05:28:49 -0000 Mailing-List: contact scm-help@geronimo.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: dev@geronimo.apache.org List-Id: Delivered-To: mailing list scm@geronimo.apache.org Received: (qmail 45245 invoked by uid 99); 12 Dec 2005 05:28:47 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 11 Dec 2005 21:28:47 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Sun, 11 Dec 2005 21:28:33 -0800 Received: (qmail 2789 invoked by uid 65534); 12 Dec 2005 05:28:13 -0000 Message-ID: <20051212052813.2787.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r356160 [8/11] - in /geronimo/branches/1.0/modules/scripts/src/resources/docs: ./ Administrative tasks_attachments/ Apache Geronimo V1 - Documentation_attachments/ Architecture_attachments/ Configuring LDAP_attachments/ Geronimo Administrat... Date: Mon, 12 Dec 2005 05:27:58 -0000 To: scm@geronimo.apache.org From: dain@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20JDBC%20Migration.html?rev=356160&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration.html Sun Dec 11 21:27:20 2005 @@ -0,0 +1,700 @@ + + + Geronimo : JBoss to Geronimo - JDBC Migration + + + + + + + + + +

+ + Geronimo : JBoss to Geronimo - JDBC Migration + +

+ This page last changed on Dec 09, 2005 by system. +

+ +

+Article donated by: Manu T George, Hernan Cunico

+ +

Overview

This article will help you migrate JDBC applications developed for JBoss v4 to Apache Geronimo. This article is part of a series of migration articles covering different types of applications migration.

+ +

This article provides details on the JDBC implementation differences between these two application servers as well as a detailed step-by-step migration procedure for porting JDBC applications from JBoss v4 to Apache Geronimo. To define a common starting point (the source environment), this article provides steps for deploying the Online Brokerage sample application into the JBoss source environment. Then you will be guided through the application migration and deployment process in Apache Geronimo.

+ +

This article is organized in the following sections:

+ +

JDBC implementation analysis
Sample application
The JBoss environment
The Geronimo environment
Step-by-step migration
Summary

+ + +

JDBC implementation analysis

JDBC implementation may vary from one vendor to another. The purpose of this section is to provide a JDBC specific feature-to-feature comparison between JBoss and Apache Geronimo so you can clearly identify the differences and plan accordingly before migration.

+ +

Given that JBoss and Geronimo both use J2CA connectors for accessing JDBC resources, there will be an overlap of some J2CA features when comparing the platform specific JDBC features.

+ +

Note: Since Geronimo is still in its infancy some of the features provided by JBoss may not yet be implemented in Geronimo.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Feature	JBoss v4	Apache Geronimo
JDBC access	JDBC access in JBoss is through JDBC connectors based on the JCA specification.	Geronimo does not have any direct integration with JDBC but supports access through the generic J2CA framework. The TranQL project has J2CA adapters for various databases.
JCA implementation	JBoss AS 4.0 implements the JCA (Java Connector Architecture) 1.5 specification instead of the JCA 1.0 in JBoss AS 3.2.	Geronimo supports the JCA 1.5 specification and is backward compatible to the JCA 1.0 specification.
Data sources supported	Supports 5 types of data sources: + + no-tx-datasource + local-tx-datasource + xa-datasource + ha-local-tx-datasource + ha-xa-datasource + +	TranQL has generic wrappers for data source, ConnectionPoolDatasource, and XADataSource.
Data source failover	JBoss has data source failover capabilities implemented through two data sources. +1) ha-local-tx-datasource - for local transactions. +2) ha-xa-datasource - for distributed transactions	TranQL has specialized drivers for certain databases (including Apache Derby, Oracle and soon DB2) that provide a tighter integration with the advanced features of the driver. +It is at this level that features such as load-balancing and failover would be provided. You can also use a C-JDBC wrapper for providing database clustering and failover.
XA support	Supports XA transactions, Local Transactions, and No transaction.	Supports XA transactions, Local Transactions, and No transaction.
Connection Manager Configurability	You can plug in your own custom connection manager if required.	The J2CA framework is interceptor based which allows different parts of the connection framework to be plugged in. +Although you cannot plug in a custom connection manager now, this capability can be added fairly easily.
JTA implementation	Full support for JTA through JBossJTA.	Transaction support is provided through JOTM and HOWL.
Connection pooling and management	JBossCX framework used for connection pooling and management.	Custom Geronimo Code and TranQL used for connection pooling and management.
Legacy driver support	JBoss provides connection to RDBMS that have not yet implemented JCA- JDBC drivers through JCA wrappers for JDBC drivers.	Geronimo also provides this through the TranQL- connector JDBC to JCA wrapper in Geronimo. Supports JDBC 3.0 and 2.1.

+ +

Sample application

This article contains a sample application to demonstrate migrating an application from JBoss to Geronimo, called Online Brokerage. It represents an online trading scenario in which users can buy and sell stocks. The application has the following five pages:

+ +

Login Page
Registration Page
User Information Page
Available Stocks Page
User Portfolio Page

+ + +

The following figure illustrates the application flow:
+

+ +

First, the user accesses the Login page. From the Login page the user enters the user name and password. If the user name or password is not valid the application throws an error message and rejects the user's login attempt. If the user name and password are correct, the user is taken to the Available Stocks page where he/she can view all the stocks that are present for sale at that time.

+ +

The user can choose to buy as many stocks as wanted, depending on the available money in the account, by clicking the Buy button.

+ +

After the transaction completes successfully the user is brought back to the Available Stocks page where he/she can buy more stocks if required.

+ +

If the user has insufficient funds to buy stocks the application will throw an error and will not process the transaction. The error message is shown at the top of the Available Stocks page. There is a User Info button on this page. On clicking this button the user is taken to the User Info page and shown the user details.

+ +

From the Available Stocks page there is a View your Portfolio link that shows all the stocks that the user owns. In that page, the user can select the stocks and quantity to sell. This page also shows the user's available cash in the User Cash field. If the user tries to sell more stocks than he has, the application will throw an error. The error message will be shown on the same page. For each successful sale the sale amount is added to the user's cash balance.

+ +

The quantity text box shows the quantity of stocks of a particular company that the user has. The Quantity to Sell field allows the user to enter the quantity of stocks to sell for a specific company. For selling and buying the radio button should be checked. This should be done after entering the values. If either the quantity to sell textbox is not filled or the selection box is not checked and you press on sell a JavaScript alert will be triggered saying that the required field is empty. On entering non numeric characters for quantity another alert will be triggered. This behavior is similar for the Available Stocks page as well.

+ +

New users can register by clicking the Register button in the login page. In the Registration page the user will enter a user id, user name, password, address and available cash.

+ +

Application classes and JSP pages

The Online Brokerage sample application consists of the following packages:

+ +

com.dev.trade.bo +
- Stock- Represents the stock of a company.
- User- Represents the user.
+

+ + +

com.dev.trade.dao +
- TradeDAO - Contains all the database access methods.
+

+ + +

com.dev.trade.exception +
- DBException - Custom exception class that is thrown for all database exceptions.
+

+ + +

com.dev.trade.servlet +
- TradeDispatcherServlet - Dispatches all the requests to the JSPs after performing required database functions.
+

+ + +

The Online Brokerage also includes the following JSP pages:

+ +

login.jsp - The login page of the application.
error.jsp - The default error page of the application.
register.jsp - The user registration page.
stocks.jsp - The Available Stocks page from where the user can buy stocks.
userstocks.jsp - The user portfolio page which shows the user's stocks. The user can sell stocks from this page.

+ + +

+ +

Tools used

The tools used for developing and building the Online Brokerage application are:

+ +

Eclipse

The Eclipse IDE was used for development of the sample application. This is a very powerful and popular open source development tool. Integration plug-ins are available for both JBoss and Geronimo. Eclipse can be downloaded from the following URL:
+http://www.eclipse.org

+ +

Apache Ant

Ant is a pure Java build tool. It is used for building the war files and populating the database for the Online Brokerage application. Ant can be downloaded from the following URL:
+http://ant.apache.org

+ +

Sample database

The database used for demostrating this application is MySQL. The sample database name is tradedb and it consists of the following three tables, STOCKS, USERS and TRADINGACCOUNT. The fields for each of these tables are described below.

+ + + + + + + + + + + + + + + + + + +

Table Name	Fields
STOCKS	ID (PRIMARY KEY) +NAME +PRICE
USERS	USERID (PRIMARY KEY) +NAME +PASSWORD +ADDRESS +CASH
TRADINGACCOUNT	USERID +STOCKID +QUANTITY

+ +

The TRADINGACCOUNT table is used to store the stocks that are owned by each user. The USERS and STOCKS tables are used to store the user and stock details. Because this is just a sample application the amount of money that a user has is entered during user registration by the user itself.

+ +

The DDL file used for populating this database is db.sql and it is located in the brokerage/sql directory.

+ +

The JBoss environment

This section shows you how and where the sample JBoss reference environment was installed so you can map this scenario to your own implementation.

+ +

Detailed instructions for installing, configuring, and managing JBoss are provided in the product documentation. Check the product Web site for the most updated documents.

+ +

The following list highlights the general tasks you will need to complete to install and configure the initial environment as the starting point for deploying the sample application.

+ +

Download and install JBoss v4 as explained in the product documentation guides. From now on the installation directory will be referred as <jboss_home>
Create a copy of the default JBoss v4 application server. Copy recursively <jboss_home>\server\default to <jboss_home>\server\<your_server_name>
Start the new server by running the run.sh -c <your_server_name> command from the <jboss_home>\bin directory.
Once the server is started, you can verify that it is running by opening a Web browser and pointing it to this URL: http://localhost:8080. You should see the JBoss Welcome window and be able to access the JBoss console.
Once the application server is up and running, the next step is to install and configure all the remaining prerequisite software required by the sample application. This step is described in the following section.

+ + +

+ +

Install and configure prerequisite software

In order to build and run the Online Brokerage application included in this article, you need to install and configure the build tool and the database that is used by the application.

+ +

Install the database

As mentioned earlier in the article, this application is using the MySQL database that can be downloaded from the following URL:
+http://www.mysql.com
+The Installation and configuration of MySQL is fairly intuitive and it is well documented in the MySQL Reference Manual available at the following URL:

+ +

http://dev.mysql.com/doc/mysql/en

+ +

Note: During the instance configuration I modified the security settings and specified "password" as the password for the root user. This user ID and password will later be used for accessing the database from the sample application.

+ +

Create sample database

Once the MySQL instance is configured you need to create the sample database that will be used by the Online Brokerage application. From a command line, type the following command to start the MySQL monitor:

+ +

mysql -u root -ppassword

+ +

Note that there is no blank between the flag -p and the password.

+ +

This will bring up the MySQL command interface as shown in the following example:

MySQL monitor interface

Welcome to the MySQL monitor.  Commands end with ; or \g.
+Your MySQL connection id is 7 to server version: 4.1.14-nt
+
+Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
+
+mysql>

+ +

From the MySQL command interface create the tradedb sample database by typing the following command:

+ +

mysql> create database tradedb;

+ +

Configure Ant

As mentioned before, Apache Ant is used to build the binaries for the Online Brokerage application. If you do not have Ant installed this is a good time for doing it and make sure that <ant_home>\bin directory is added to the system's path variable.

+ +

Apache Ant can be downloaded from the following URL:

+ +

http://ant.apache.org

+ +

Configure resources

In order to successfully build and deploy the Online Brokerage application and database, you will first need to configure some resources. This section describes how to configure a MySQL data source in JBoss.

+ +

Data source

The Online Brokerage application is a Web application that uses a data source to connect to the MySQL database. To use JBoss with MySQL you need to copy the MySQL driver into the JBoss server classpath. The driver, which is provided by the database vendor, is called Connector/J 3.0 and can be downloaded from the following URL:
+http://dev.mysql.com/downloads/connector/j/3.0.html

+ +

After downloading and extracting the driver, copy the mysql-connector-java-3.1.10-bin.jar file to the <jboss_home>\server\<your_server_name>\lib directory.

+ +

The data source configuration in JBoss is done through an XML configuration file. The JBoss installation contains sample configuration files for many popular databases including MySQL.

+ +

The sample data source configuration file for MySQL is mysql-ds.xml and it is located in the <jboss_home>\docs\examples\jca directory:

+ +

Copy the mysql-ds.xml file to the deploy directory of your JBoss server (<jboss_home>\server\<your_server_name>\deploy) and edit it as shown in the following example:

+ +

Update the mysql-ds.xml file

<jndi-name>jdbc/TradeDB</jndi-name>
+<connection-url>jdbc:mysql://localhost:3306/tradedb</connection-url>
+<driver-class>com.mysql.jdbc.Driver</driver-class>
+<user-name>root</user-name>
+<password>password</password>
+<exception-sorter-class-name>
+org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter
+</exception-sorter-class-name>

+ +

Delete all the other tags inside the <local-tx-datasource> tag and save the file. JBoss will automatically deploy the data source.

+ +

Build the sample application

The Online Brokerage application included with this article provides an Ant script that you will use in order to build the application and populate the database. Download the Online Brokerage application from the following link:

+ +

Online Brokerage|^brokerage.zip]

+ +

After extracting the zip file, a brokerage directory is created. In that directory open the build.properties file and edit the properties to match your environment as shown in the following example:

+ +

Update the build.properties file

# Replace server.name with either jboss or geronimo depending on which server to deploy.
+server.name=jboss
+#Replace <JAVA_HOME> with your JDK home directory
+java.home=<JAVA_HOME>
+#Replace <JBOSS_HOME> with the root directory for your specific JBoss server <jboss_home>\servers\<server_name>
+jboss.home=<JBOSS_HOME>
+#fully qualified name of the JDBC driver class
+db.driver=com.mysql.jdbc.Driver
+#database URL
+db.url=jdbc:mysql://localhost:3306/tradedb
+#database userId
+db.userid=root
+#database password
+db.password=password
+#script files for creating the tables
+sql.file=sql/db.sql
+#location of the jdbc driver jar.
+driver.classpath=<jboss_home>/server/<your_server_name>/lib/mysql-connector-java-3.1.10-bin.jar

+ +

When specifying the driver.classpath in the build.properties file, make sure to use just the forward slash "/" , otherwise the build will not find the jar file.

+ +

From a command prompt or shell go to the brokerage directory and run ant. This will build the war file and place it directly in the brokerage directory. The war created by the ant build contains a JBoss specific deployment descriptor, the jboss-web.xml file in the WEB-INF directory of the WAR is shown in the following example.

+ +

JBoss deployment descriptor

<?xml version="1.0" encoding="UTF-8"?>
+<jboss-web>
+  <context-root>/brokerage</context-root>
+  <resource-ref>
+      <res-ref-name>jdbc/TradeDB</res-ref-name>
+      <res-type>javax.sql.DataSource</res-type>
+      <jndi-name>java:jdbc/TradeDB</jndi-name>
+  </resource-ref>
+</jboss-web>

+ + +

The resource-ref element is used to map the resource referred to by the name jdbc/TradeDB in the web.xml file to the resource with the JNDI name java:jdbc/TradeDB i.e. the MySQL datasource.

+ +

Deploy the sample application

To deploy the Online Brokerage application in JBoss, copy the brokerage.war file you just built with Ant to the following directory:

+ +

<jboss_home>\server\<your_server_name>\deploy

+ +

If JBoss is already started, it will automatically deploy and start the application; otherwise, the application will be deployed and started at the next startup.

+ +

Test the sample application

To test the application, open a Web browser and access the following URL:

+ +

http://localhost:8080/brokerage

+ +

This brings up the login screen of the Online Brokerage application. Enter j2ee as the user name and password as the password and click on login. This takes you to the available stocks page illustrated in the following figure. The application is now configured and running.

+ +

Tip
If you want to use another root password for the database, replace the occurrences of 'password' with the required password. This has to be changed in the following three places: +

MySQL instance configuration.
Data source configuration file.
build.properties file used by the Ant build script.

+ +

The Geronimo environment

Download and install Geronimo from the following URL:

+ +

http://geronimo.apache.org/downloads.html

+ +

The release notes available there provide clear instructions on system requirements and how to install and start Geronimo. Throughout the rest of this article we will refer to the Geronimo installation directory as <geronimo_home>.

+ +

TCP/IP ports conflict
If you are planning to run JBoss and Geronimo on the same machine consider to change the default service ports on, at least, one of these servers.

+ +

Configure resources

In Geronimo the JDBC resources are implemented using J2EE connectors. Therefore, you need to write a Geronimo specific deployment plan for deploying a JDBC datasource. Additionally, while doing the deployment you need to provide the deployer with the tranql-connector-1.0.rar file. This RAR file contains the connection pool management logic for Geronimo.

+ +

For running the Online Brokerage application in Geronimo, you will be using the same MySQL database that was used with JBoss. So the only task you need to do in order to prepare the Geronimo environment is to configure the data source.

+ +

Configure the data source

The first thing you need to do is to copy the MySQL database driver into the Geronimo repository so that you can refer to it in the data source deployment plan.

+ +

The Geronimo repository is located at <geronimo_home>/repository. Inside this directory, create a directory called mysql/jars and copy the mysql-connector-java-3.1.10-bin.jar file into it. Now, you need to create the data source deployment plan.

+ +

Different types of data sources
There are three types of data sources that Geronimo supports: +

Global data source - Visible to all the applications on a Geronimo Instance.
Application scoped data source - Visible to a single application within which it is defined.
Module scoped data source - Visible to a single module within which it is defined.

+ + +

For this migration exercise you will be using a Global data source. For instructions on configuring and using the other two types of data sources see the the following developerWorks article:

+ +

http://www.ibm.com/developerworks/opensource/library/os-ag-jdbc/

+ +

Create the data source deployment plan

First, create an xml file called mysql-geronimo-plan.xml. Copy the plan shown in the following example and paste it in the xml file.

Data source deployment plan

<?xml version="1.0"?>
+
+<connector xmlns="http://geronimo.apache.org/xml/ns/j2ee/connector" 
+           version="1.5" configId="org/apache/geronimo/Mysql" 
+           parentId="org/apache/geronimo/Server">
+<dependency>
+  <uri>mysql/jars/mysql-connector-java-3.1.10-bin.jar</uri>
+</dependency>
+<resourceadapter>
+  <outbound-resourceadapter>
+    <connection-definition>
+      <connectionfactory-interface> 
+        javax.sql.DataSource 
+      </connectionfactory-interface>
+      <connectiondefinition-instance>
+        <name>TradeDS</name>
+        <config-property-setting name="UserName"> 
+          root 
+        </config-property-setting>
+        <config-property-setting name="Password"> 
+          password
+        </config-property-setting>
+        <config-property-setting name="Driver"> 
+          com.mysql.jdbc.Driver 
+        </config-property-setting>
+        <config-property-setting name="ConnectionURL">
+          jdbc:mysql://localhost:3306/tradedb
+        </config-property-setting>
+        <config-property-setting name="CommitBeforeAutocommit"> 
+           false 
+        </config-property-setting>
+        <config-property-setting name="ExceptionSorterClass"> 
+           org.tranql.connector.NoExceptionsAreFatalSorter
+        </config-property-setting>
+
+        <connectionmanager>
+          <local-transaction/>
+          <single-pool>
+             <max-size>10</max-size>
+             <min-size>0</min-size>
+             <blocking-timeout-milliseconds> 
+                5000 
+              </blocking-timeout-milliseconds>
+              <idle-timeout-minutes>
+                30
+              </idle-timeout-minutes>
+              <match-one/>
+          </single-pool>
+        </connectionmanager>
+
+        <global-jndi-name> 
+          jdbc/TradeDB
+        </global-jndi-name>
+
+      </connectiondefinition-instance>
+    </connection-definition>
+  </outbound-resourceadapter>
+</resourceadapter>
+</connector>

+ +

The listing above shows the plan for deploying a J2EE connector which will provide JDBC access to the database. The root element is the <connector> element. This element has the following four attributes:

+ +

xmlns - specifies the XML namespace.
version - specifies that the J2EE connector conforms to the JCA 1.5 specification.
configId - specifies the name Geronimo uses to refer to the connector internally.
parentId - specifies the parent of this configuration.

+ + +

Other important elements and attributes are:

+ +

connectionfactory-interface - Must be javax.sql.DataSource.
connectiondefinition-instance - Contains the configuration properties required to connect to the database.
connectionmanager - Contains the configuration settings for the geronimo connection manager.
config-property-setting - Specifies the value of a single configuration property of the connector.
name - Name of the data source.
local-transaction - The presence of this element enables the resource adapter to support local transactions. If the 'no-transaction' element is present instead of 'local-transaction', then the resource adapter will not support transactions. If the 'xa-transaction' element is present instead of 'local-transaction', then the resource adapter will support xa-transactions.
single-pool - Contains the connection pool configuration properties such as max-size and min-size for a single pool. If the 'no-pool' element is present instead of 'single-pool', then the connections will not be pooled. If 'partitioned-pool' element is present instead of 'single-pool', then there will be a number of connection pools based on the partition type.
max-size - Maximum number of connections allowed simultaneously.
min-size - Minimum size of the connection pool.
blocking-timeout-milliseconds - Time for which a caller will be made to wait for a connection, if all the connections in the pool are currently in use, before throwing an exception.
idle-timeout-minutes - Time in minutes after which a connection will timeout if it is idle.
global-jndi-name - This is the JNDI name used to access this data source from a client.

+ + +

The following table shows the configuration properties that are specified by the config-property-setting element.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Configuration Property	Meaning
Driver	Fully qualified class name of the JDBC driver.
ConnectionURL	The JDBC connection URL. This can contain parameters when supported by the driver. For example, for MySQL to use named pipes instead of TCP/IP you can attach `?socketFactory=com.mysql.jdbc.NamedPipeSocketFactory` to the JDBC connection URL.
UserName	The user name needed to connect to the database.
Password	The password needed to connect to the database.
CommitBeforeAutocommit	In case the JDBC driver does not commit the pending data changes when `setAutoCommit` (true) is called.
ExceptionSorterClass	To provide information to the pool whether the Exceptions that occur are fatal or not.

+ +

After creating the MySQL deployment plan we need to deploy the connection pool datasource by running the deployer tool.

+ +

From a command line change directory to <geronimo_home> and run the following command:

+ +

If the Geronimo instance is stopped:
+java -jar bin/deployer.jar distribute <geronimo_home>\repository\mysql\jars\mysql-geronimo-plan.xml <geronimo_home>\repository\tranql\rars\tranql-connector-1.0.rar

+ +

If the Geronimo instance is running:

+ +

java -jar bin/deployer.jar --user system --password manager deploy <geronimo_home>\repository\mysql\jars\mysql-geronimo-plan.xml <geronimo_home>\repository\tranql\rars\tranql-connector-1.0.rar

+ +

This will deploy the data source. Now you are ready to proceed with the migration.

+ +

Step-by-step migration

Geronimo does not support accessing external resources(JDBC datasources) by setting JNDI properties at runtime as shown in the following example:

+ +

Context ctx = null;
+Hashtable env = new Hashtable();
+env.put(Context.INITIAL_CONTEXT_FACTORY, "Geronimo specific factory"); 
+env.put(Context.PROVIDER_URL, "provider URL for geronimo");
+     ctx = new InitialContext(env)

+ +

This is because reference resolution is done at deploy time and is based on the JSR-77 object names of the target component. In order to migrate the Online Brokerage application to Geronimo, you first need to replace the jboss-web.xml file with a geronimo-web.xml file which is the Geronimo-specific descriptor file.

+ +

The geronimo-web.xml file is located in the <brokerage_home>\web\descriptors\geronimo directory and looks like the following example.

+ +

geronimo-web.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
+<web-app xmlns="http://geronimo.apache.org/xml/ns/web" 
+         xmlns:naming="http://geronimo.apache.org/xml/ns/naming" 
+         configId="BrokerageApp" parentId="org/apache/geronimo/Mysql">
+<context-root>/brokerage</context-root>
+<naming:resource-ref>
+	<naming:ref-name>jdbc/TradeDB</naming:ref-name>
+     <naming:resource-link>TradeDS</naming:resource-link>
+</naming:resource-ref>
+</web-app>

+ +

As shown in the example, the parent for this configuration is the MySQL J2EE connector. The naming:resource-ref element maps the TradeDS data source to the name jdbc/TradeDB. The context-root element gives the context-root of the application.

+ +

These are the only changes required to run this application on Geronimo.

+ +

In order to build the .war file for Geronimo, you can modify the build.properties file that is provided with the sample application to remove the jboss-web.xml and include the geronimo-web.xml. This is done by changing the server.name property to geronimo. Also you need to specify the property geronimo.home in the build script.

+ +

The two values that you need to modify are:

+ +

server.name=geronimo
+geronimo.home=<geronimo_home>

+ +

The build.properties is used by the build script to pick up the J2EE specs for Geronimo. If your jboss.home property is still valid, it is not required to set this property. If this property is not set and the jboss.home is also not valid then you will get compilation errors. You also need to set the driver.classpath to point to the new driver jar. Now from the command prompt go to the brokerage directory and run ant. This builds the war file and places it directly in the brokerage directory.

+ +

Deploy the migrated sample application

To deploy the migrated Online Brokerage application, make sure the Geronimo server is up and running.

+ +

From a command line, change directory to <geronimo_home> and type the following command:

+ +

java -jar bin/deployer.jar --user system --password manager deploy <brokerage_home>/brokerage.war

+ +

Once the application is deployed, open a Web browser and access the following URL:

+ +

http://localhost:8080/brokerage

+ +

Summary

This article has shown you how to migrate a sample application, from JBoss to the Apache Geronimo application server. You followed step-by-step instructions to build the application, deploy and run it, and then migrate it to the Geronimo environment.

+ +

The following list summarizes the major differences found during this sample application migration.

+ +

In the Geronimo specific deployment descriptor the resource reference name is mapped to the name of the datasource unlike in the JBoss specific deployment descriptor where the resource name is mapped to the JNDI name of the datasource.
In order to deploy a datasource in JBoss you need to just copy the configuration file to the deploy directory but in Geronimo you need to use the deployer tool.
At this time, Geronimo does not support accessing external resources (i.e.:JDBC datasources) by setting JNDI properties at runtime. This resources need to be specified at deployment time.

+ + +

+ +
+

+ Attachments: +

+ +

+ JSP_flow.jpg (image/pjpeg) +
+

+ brokerage.zip (application/x-zip-compressed) +
+

+ availableStocks.jpg (image/pjpeg) +
+

+ +

+ + + + + + + +

Document generated by Confluence on Dec 09, 2005 22:10

+ + \ No newline at end of file Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration.html ------------------------------------------------------------------------------ svn:executable = * Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/JSP_flow.jpg URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20JDBC%20Migration_attachments/JSP_flow.jpg?rev=356160&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/JSP_flow.jpg ------------------------------------------------------------------------------ svn:executable = * Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/JSP_flow.jpg ------------------------------------------------------------------------------ svn:mime-type = image/jpeg Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/availableStocks.jpg URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20JDBC%20Migration_attachments/availableStocks.jpg?rev=356160&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/availableStocks.jpg ------------------------------------------------------------------------------ svn:executable = * Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/availableStocks.jpg ------------------------------------------------------------------------------ svn:mime-type = image/jpeg Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/brokerage.zip URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20JDBC%20Migration_attachments/brokerage.zip?rev=356160&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/brokerage.zip ------------------------------------------------------------------------------ svn:executable = * Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - JDBC Migration_attachments/brokerage.zip ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20Security%20Migration.html?rev=356160&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration.html Sun Dec 11 21:27:20 2005 @@ -0,0 +1,389 @@ + + + Geronimo : JBoss to Geronimo - Security Migration + + + + + + + + + +

+ + Geronimo : JBoss to Geronimo - Security Migration + +

+ This page last changed on Dec 09, 2005 by system. +

+ +

+Article donated by: Ivan S Dubrov, Artem Papkov, Hernan Cunico

+ +

Overview

This article will help you migrate security applications developed for JBoss v4 to Apache Geronimo. This article is part of a series of migration articles covering different types of applications migration.

+ +

This article provides some details on the differences between these two application servers as well as a detailed step-by-step migration procedure for porting security application from JBoss v4 to Apache Geronimo. To define a common starting point (the source environment), this article provide steps for deploying the sample application into the JBoss source environment. Then you will be guided through the application migration and deployment process onto Apache Geronimo.

+ +

This article is organized in the following sections:

+ +

Security implementation analysis
Sample application
The JBoss environment
The Geronimo environment
Step-by-step migration
Summary

+ + +

Security implementation analysis

Support of J2EE features may vary from one vendor to another and different vendors provide different ways to extend respective specifications and default behaviors with custom ones. The purpose of this section is to provide comparison of similar JBoss and Geronimo features which were applied for the implementation of sample applications. You can use the information below to clearly identify the differences of these two servers and plan accordingly before migration from one to another.

+ + + + + + + + + + + + + + + + + + + + + + +

Features	JBoss v4	Apache Geronimo
Custom login modules	Supports custom login modules. Custom login modules can be installed as part of the service archive (SAR).	Supports custom login modules
J2EE security	Supports both declarative and programmatic J2EE security.	Supports both declarative and programmatic J2EE security.
Deploying realm configuration	Supports deployment of realm configuration as part of the service archive (SAR).	Realm configuration can be deployed as part of the module or as part of the application.

+ +

Sample application

The Security application represents a sample application that exploits security related features in the JBoss. It represents a simple document manager in which users can view and upload documents. It consists of the following three pages:

Login Page
Documents Page
Login Error Page

+ + +

+ +

The application starts with the Login page. After logging in the user is redirected to the Documents page. There are two types of users - viewers and editors. Both kinds can view documents, but only the editor can upload them.

+ +

If a user has "editor" role, the upload form is displayed below the documents list. When the user selects a document and presses the "upload" button, the upload method of the BusinessLogic EJB is invoked through the execution of the "Upload" servlet. The Security application will throw an exception if a non-authorized user attempts to call the upload servlet.

+ +

Users are defined through the property files j2g_users.properties and j2g_groups.properties located in the <security_home>/properties directory.

+ +

Two predefined users are "user" with password "1" and "editor" with password "2".

+ +

Application classes and JSP pages

The Application contains the following JSP pages:

login.jsp - The login page of the application.
loginError.jsp - The default error page of the application.
main.jsp - The main application page with documents list
upload Servlet - Servlet that handles the uploads
BusinessLogicEJB - Stateless Session EJB that handles uploads.

+ + +

+ +

Tools used

The tools used for developing and building security sample application are:

+ +

Eclipse with JBoss IDE

The Eclipse with JBoss IDE plug-ins was used for development of Java-source code of the sample applications. Eclipse is a very powerful and popular open source development tool. Eclipse can be downloaded from the following URL:

+ +

http://www.eclipse.org

+ +

JBoss plug-ins are also open source extensions for Eclipse that add some helpful features for creation of J2EE applications (which are not designed for deployment on JBoss only). These plug-ins can be downloaded from the following URL:

+ +

http://sf.net/projects/jboss

+ +

Apache Ant

Ant is a pure Java build tool. It is used for building the war files and populating the database for the Online Brokerage application. Ant can be downloaded from the following URL:

+ +

http://ant.apache.org

+ +

XDoclet

XDoclet is a tool for generating various artifacts (deployment descriptors, source code) basing on the JavaDoc tags. XDoclet can be downloaded from the following URL:

+ +

http://xdoclet.sourceforge.net

+ +

The JBoss environment

This section shows you how and where the sample JBoss reference environment was installed so you can map this scenario to your own implementation.

+ +

Detailed instructions for installing, configuring, and managing JBoss are provided in the product documentation. Check the product Web site for the most updated documents.

+ +

The following list highlights the general tasks you will need to complete to install and configure the initial environment as the starting point for deploying the sample application.

+ +

Download and install JBoss v4 as explained in the product documentation guides. From now on the installation directory will be referred as <jboss_home>
Create a copy of the default JBoss v4 application server. Copy recursively <jboss_home>\server\default to <jboss_home>\server\<your_server_name>
Start the new server by running the run.sh -c <your_server_name> command from the <jboss_home>\bin directory.
Once the server is started, you can verify that it is running by opening a Web browser and pointing it to this URL: http://localhost:8080. You should see the JBoss Welcome window and be able to access the JBoss console.
Once the application server is up and running, the next step is to install and configure all the remaining prerequisite software required by the sample application. This step is described in the following section.

+ + +

+ +

Install and configure prerequisite software

Compilation of source code of the sample applications is based on Java libraries distributed along with JBoss. The only additional software which is required for building the applications is Apache Ant.

+ +

Apache Ant

If you do not have Ant installed, this is a good time for doing so and making sure that <ant_home>\bin directory is added to the path system environment variable. Apache Ant can be downloaded from the following URL:

+ +

http://ant.apache.org

+ +

XDoclet

If you do not have XDoclet installed, this is a good time for doing so. Although XDoclet installation is not required to build the sources at this time. It will be required for modifying the source code. The XDoclet can be downloaded from the following URL:

+ +

http://xdoclet.sourceforge.net

+ +

Build the sample application

The Security sample application included with this article provides an Ant script that you will use in order to build the application. Download the Securityapplication from the following link:

+ +

Security Sample

+ +

After extracting the zip file a security directory is created, from now on this directory will be referred as <security_home>. In that directory open the build.properties file and edit the properties to match your environment as shown in the following example:

+ +

build.properties

# Home directory of JBoss 4.0.2 J2ee Application Server and name of the server 
+# instance on which the application should be deployed (JBoss is also used for 
+# building purposes):
+jboss.home = <jboss_home>
+jboss.server = <your_server_name>

+ +

After the properties are specified run the command ant all in the same directory. Ant will build the Enterprise application archive containing the sample application for JBoss. The archives together with any additional required files (if any) will be placed into the <security_home>/build/jboss directory.

+ +

Deploy the sample application

To deploy the Security application on JBoss, copy the security.ear from the <security_home>/build/jboss directory into the <jboss_home>\server\<your_server_name>\deploy directory.

+ +

If JBoss is running, it will automatically deploy and start the application. Otherwise, the application will be deployed and started at the next invocation of the application server.

+ +

Test the sample application

To test the application, open a Web browser and access the following URL:

+ +

http://localhost:8080/security

+ +

Try logging in as "user" and as "editor". Try invoking upload servlet directly typing the following URL in the browser http://localhost:8080/security/upload, you should receive an exception if you do not use an "editor" type user.

+ +

The Geronimo environment

Download and install Geronimo from the following URL:

+ +

http://geronimo.apache.org/downloads.html

+ +

TCP/IP ports conflict
If you are planning to run JBoss and Geronimo on the same machine consider to change the default service ports on, at least, one of these servers.

+ +

Step-by-step migration

Geronimo does not have an equivalent of the JBoss service archives (SARs). In the Security sample application, this archive is used for deploying the realm configuration on JBoss. In the case of Geronimo, this configuration can be placed in the application-wide Geronimo deployment plan geronimo-application.xml.

+ +

The following steps were performed to migrate the sample application:

+ +

Developed a Geronimo specific deployment plan for the Enterprise application. The geronimo-application.xml deployment plan is located in the <security_home>modules/security.ear/src/META-INF/geronimo directory. During the build process, this deployment plan is placed in the META-INF subdirectory in the EAR archive and should look like the following example:

+ + +

geronimo-application.xml

<?xml version="1.0" encoding="UTF-8"?>
+<application xmlns="http://geronimo.apache.org/xml/ns/j2ee/application"
+	configId="com/ibm/j2g/security"
+	parentId="org/apache/geronimo/Server">
+
+    <security xmlns="http://geronimo.apache.org/xml/ns/security">
+        <default-principal realm-name="j2g">
+            <principal class="org.apache.geronimo.security.realm.providers.GeronimoUserPrincipal" name="system"/>
+        </default-principal>
+        <role-mappings>
+            <role role-name="authenticated">
+                <realm realm-name="j2g">
+                    <principal class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal" name="authenticated"/>
+                </realm>
+            </role>
+            <role role-name="uploader">
+                <realm realm-name="j2g">
+                    <principal class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal" name="uploader"/>
+               </realm>
+            </role>
+        </role-mappings>
+    </security>
+
+   	<gb:gbean name="j2g-realm" class="org.apache.geronimo.security.realm.GenericSecurityRealm"
+   		xmlns:gb="http://geronimo.apache.org/xml/ns/deployment-1.0">
+        <gb:reference name="ServerInfo">
+        	<gb:application>*</gb:application>
+        	<gb:module>org/apache/geronimo/System</gb:module>
+        	<gb:name>ServerInfo</gb:name>
+        </gb:reference>
+        <gb:reference name="LoginService">
+        	<gb:application>*</gb:application>
+        	<gb:module>org/apache/geronimo/Security</gb:module>
+        	<gb:name>JaasLoginService</gb:name>
+        </gb:reference>
+    	<gb:attribute name="realmName">j2g</gb:attribute>
+    	<gb:xml-reference name="LoginModuleConfiguration">
+    		<l:login-config xmlns:l="http://geronimo.apache.org/xml/ns/loginconfig">
+    			<l:login-module control-flag="REQUIRED" server-side="true">
+    				<l:login-domain-name>j2g</l:login-domain-name>
+    				<l:login-module-class>
+    					org.apache.geronimo.security.realm.providers.PropertiesFileLoginModule
+    				</l:login-module-class>
+     				<l:option name="usersURI">
+				    	var/security/j2g_users.properties
+			        </l:option>
+        			<l:option name="groupsURI">
+          				var/security/j2g_groups.properties
+        			</l:option>
+    			</l:login-module>
+    		</l:login-config>
+    	</gb:xml-reference>
+    </gb:gbean>
+</application>

+ +

Note that in contrast to JBoss, application roles must be explicitly defined in the deployment plan.

+ +

Created a Geronimo specific deployment plan for the EJB module openejb-jar.xml. This deployment plan is located in the <security_home>/modules/security.jar/src/META-INF/geronimo/openejb-jar.xml. During the build the file is copied to the META-INF subdirectory of the security.jar EJB module. This deployment plan should look like the following example:

+ + +

openejb-jar.xml

<?xml version="1.0"?>
+<openejb-jar xmlns="http://www.openejb.org/xml/ns/openejb-jar"
+    configId="com/ibm/j2g/security/ejb" parentId="com/ibm/j2g/security">
+    <enterprise-beans>
+    	<session>
+    		<ejb-name>BusinessLogic</ejb-name>
+    	</session>
+    </enterprise-beans>
+</openejb-jar>

+ +

Created a Geronimo specificdeployment plan for the Web module geronimo-web.xml. This plan is located in the security/modules/security.war/src/WEB-INF/geronimo/geronimo-web.xml. During the build, this file is copied to the WEB-INF subdirectory of the security.war Web module. This deployment plan should look like the following example:

+ + +

geronimo-web.xml

<web-app xmlns="http://geronimo.apache.org/xml/ns/web" 
+   configId="com/ibm/j2g/security/web" parentId="com/ibm/j2g/security">
+    <context-root>/security</context-root>
+    <context-priority-classloader>true</context-priority-classloader>
+    <security-realm-name>j2g</security-realm-name> 
+</web-app>

+ +

Rewrited the properties files with users to group mapping. JBoss login module have mapping in the form of "user=group1,group2" and Geronimo have mapping in the form of "group=user1,user2".

+ + +

Since the realm configuration is done in the geronimo-application.xml, the SAR archive is not required anymore. Actually, this archive can contain custom login modules as well, but since there is some difficulties regarding the deployment of custom login modules to Geronimo (see JIRA GERONIMO-1044 ) they are not covered in this article.

+ +

Build the migrated sample application

In order to build modules of the Security application file for Geronimo, make sure that the properties starting with the prefix jboss still match your environment. The build scripts still refer to JBoss libraries for J2EE API interfaces required for the source code compilation.

+ +

You can update the classpath in the build.xml file to point to Geronimo and get the jars from there and not from JBoss.

+ +

After the properties have been specified, run the ant all command in the <security_home> directory. Ant will build the Enterprise application archive containing the sample application for Geronimo. The archives together with additional required files (if any) will be placed in the <security_home>/build/geronimo directory.

+ +

The build system was updated to include Geronimo-specific deployment plan in the application modules. SAR archive was removed from the build.

+ +

Deploy the migrated sample application

To deploy the migrated Security application, make sure the Geronimo server is up and running.

+ +

Copy the properties files with users and groups definition from the <security_home>/properties directory to the <geronimo_home>/var/security directory

+ +

From a command line, change directory to <geronimo_home>/bin and type the following command:

+ +

java -jar deployer.jar --user system --password manager deploy <security_home>/build/geronimo/security.ear

+ +

Once the application is deployed, open a Web browser and access the following URL:

+ +

http://localhost:8080/security

+ +

Summary

This article showed you how to migrate a Security application that exploits some of the J2EE security-related features such as EJB declarative security, Web declarative security and Web programmatic security.

+ +

In both environments built-in login module was used. This article showed that such kind of applications require minimal migration efforts, although in more complex cases there could be more time-consuming issues.

+ +

+ +
+

+ Attachments: +

+ +

+ secApp_flow.jpg (image/pjpeg) +
+

+ security.zip (application/x-zip-compressed) +
+

+ Security_test.jpg (image/pjpeg) +
+

+ +

+ + + + + + + +

Document generated by Confluence on Dec 09, 2005 22:10

+ + \ No newline at end of file Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration.html ------------------------------------------------------------------------------ svn:executable = * Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration_attachments/Security_test.jpg URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20Security%20Migration_attachments/Security_test.jpg?rev=356160&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration_attachments/Security_test.jpg ------------------------------------------------------------------------------ svn:executable = * Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration_attachments/Security_test.jpg ------------------------------------------------------------------------------ svn:mime-type = image/jpeg Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss to Geronimo - Security Migration_attachments/secApp_flow.jpg URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/JBoss%20to%20Geronimo%20-%20Security%20Migration_attachments/secApp_flow.jpg?rev=356160&view=auto ============================================================================== Binary file - no diff available.