Author: Chen, Nan Date: Feb 18, 2010

Transcription

1 Migrate a JEE6 Application with JPA 2.0, EJB 3.1, JSF 2.0, and Servlet 3.0 from Glassfish v3 to WebSphere Application Server v8 Author: Chen, Nan nanchen@cn.ibm.com Date: Feb 18, IBM Corporation

2 THE INFORMATION CONTAINED IN THIS REPORT IS PROVIDED FOR INFORMATIONAL PURPOSES ONLY. ALTHOUGH EFFORTS WERE MADE TO VERIFY THE COMPLETENESS AND ACCURACY OF THE INFORMATION CONTAINED IN THIS PRESENTATION, IT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN ADDITION, THIS INFORMATION IS BASED ON IBM S CURRENT PRODUCT PLANS AND STRATEGY, WHICH ARE SUBJECT TO CHANGE BYIBM WITHOUT NOTICE. IBM SHALL NOT BE RESPONSIBLE FOR ANY DAMAGES ARISING OUT OF THE USE OF, OR OTHERWISE RELATED TO, THIS REPORT OR ANY OTHER DOCUMENTATION. NOTHING CONTAINED IN THIS REPORT IS INTENDED TO, OR SHALL HAVE THE EFFECT OF CREATING ANY WARRANTY OR REPRESENTATION FROM IBM (OR ITS AFFILIATES OR ITS OR THEIR SUPPLIERS AND/OR LICENSORS); OR ALTERING THE TERMS AND CONDITIONS OF THE APPLICABLE LICENSE AGREEMENT GOVERNING THE USE OF IBM SOFTWARE.

3 Trademarks and Service Marks The following terms are trademarks of the IBM Corporation in the United States or other countries or both: IBM WebSphere WebSphere Application Server Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other company, product and service names may be trademarks or service marks of others.

4 Executive Summary IBM WebSphere Application Server V8.0 continues programming model productivity and ease of use enhancements through support for portions of key Java Enterprise Edition 6.0 specifications, which include Enterprise JavaBeans 3.1, Java Persistence API (JPA) 2.0, JavaServer Faces (JSF) 2.0, JavaServer Pages (JSP) 2.2, Servlet 3.0, Java EE Connector Architecture 1.6, Contexts and Dependency Injection for Java (CDI)[1]. GlassFish is an open source application server project led by Oracle and/or its affiliates for the Java EE platform[2]. It is compliant with Java EE 6 from V3, and it is a popular application server in the open source world. This test scenario verified the procedure of migrating a JEE6 application which includes JPA 2.0, EJB 3.1, JSF 2.0, Servlet 3.0 from Glassfish V3 to WebSphere Application Server V8.0, in order to discover any potential defect or issue.

5 Audience This report is intended for developers and administrators who want to migrate existing JEE6 applications from Glassfish V3 to WebSphere Application Server V8.0.

6 Scenario Description Objective: This test case focuses on migrating JEE6 example (pet catalog, which includes JPA 2.0, EJB 3.1, JSF 2.0, Servlet 3.0) from GlassFish v3 + MySQL to WebSphere Application Server V8.0 + Derby to discover any potential defect or issue. IBM Rational Application Developer V8 has been used to modify the pet catalog example. If an existing Glassfish application can be migrated to WebSphere Application Server V8 easily, what's the benefit? It provides more options for customers running their existing Java EE 6 application. Customers will not be worried about migration effort if they plan to migrate application server from Glassfish to WebSphere Application Server V8.0. The following slides will give an introduction about JEE6 features (JPA 2.0, EJB 3.1, JSF 2.0, Servlet 3.0) in pet catalog application.

7 Concept highlights: JEE6 feature in Petcatalog --EJB 3.1 light 1. Session Bean with no-interface View 2. Simplified packaging [3] ItemFacade.java import javax.ejb.stateless;... Stateless public class ItemFacade implements Serializable = "catalogpu") private EntityManager em;... public List<Item> findrange(int maxresults, int firstresult) { Query q = em.createquery("select object(o) from Item as o"); q.setmaxresults(maxresults); q.setfirstresult(firstresult); return q.getresultlist(); } public int getitemcount() { return ((Long) em.createquery("select count(o) from Item as o").getsingleresult()).intvalue(); } } private ItemFacade itemfacade;... public List<Item> getnextitems(int maxresults, int firstresult) { return itemfacade.findrange(maxresults, firstresult); }... Client of of the the bean. public int getitemcount() { NOTE: The bean above has no no return itemfacade.getitemcount(); interfaces and all all public methods of of the the } bean class are are automatically exposed to to... the the caller. The client of of this bean can simply invoke them. Petcatalog.war WEB-INF/classes/controller catalog.class... It It is is an EJB; it it can be directly packaged into a war, no need to to use ejb-jar.xml file. NOTE:The EJB 3.1 specification removes the restriction that enterprise bean classes must be packaged in in an ejb-jar file. You now have the option of of placing EJB classes directly in in the.war file, using the same packaging guidelines that apply to to web application classes. This means that you can place EJB classes under the WEB-INF/classes directory or or in in a.jar file within the WEB-INF/lib directory. The EJB deployment descriptor is is also optional. If If it's needed, you can package it it as as a WEB-INF/ejbjar.xml file.

8 Concept highlights: JEE6 feature in Petcatalog JSF 2.0 [4] JSF 2.0 facelets XHTML... <h:datatable var="row" value="#{catalog.items}"...> <h:column> <f:facet name="header"> <h:outputtext value="#{msgs.name}"/> </f:facet> <h:outputtext value="#{row.name}"/> </h:column>... </h:datatable>... list.xhtml The List.xhtml facelets page uses a JSF datatable component to to display a list of of catalog items in in an an html table. The datatable component is is useful when you want to to show a set of of results in in a table. In In a JavaServer Faces application, the UIData component (the superclass of of datatable) supports binding to to a collection of of data objects. It It does the work of of iterating over each record in in the data source. The HTML datatable renderer displays the data as as an HTML table.

9 Concept highlights: JEE6 feature in Petcatalog JPA [4] public class Catalog implements Serializable = "catalogpu") private EntityManagerFactory emf; private EntityManager getentitymanager() { return emf.createentitymanager(); } public List<Item> getnextitems(int maxresults, int firstresult) { EntityManager em = getentitymanager(); try { Query q = em.createquery("select object(o) from Item as o"); q.setmaxresults(maxresults); q.setfirstresult(firstresult); return q.getresultlist(); } finally { em.close(); } } The Catalog ManagedBean uses the Java Persistence API EntityManager Query object to to return a list of of items. The Catalog ManagedBean annotates the field private EntityManager em which causes an entity manager factory to to be injected when the managed bean is is instantiated. public class Item implements java.io.serializable private Integer id; private String name; private String description; private String imageurl; private String imagethumburl; private BigDecimal price;... The Item entity class maps to to the ITEM table that stores the item instances. This is is a typical Java Persistence entity object. There are two requirements for an entity: annotating the class with an annotation annotating the primary key identifier

10 Concept highlights: JEE6 feature in Petcatalog JPA [4] public class Catalog implements Serializable = "catalogpu") private EntityManagerFactory emf; private EntityManager getentitymanager() { return emf.createentitymanager(); } public List<Item> getnextitems(int maxresults, int firstresult) { EntityManager em = getentitymanager(); try { Query q = em.createquery("select object(o) from Item as o"); q.setmaxresults(maxresults); q.setfirstresult(firstresult); return q.getresultlist(); } finally { em.close(); } } The Catalog ManagedBean uses the Java Persistence API EntityManager Query object to to return a list of of items. The Catalog ManagedBean annotates the field private EntityManager em which causes an entity manager factory to to be injected when the managed bean is is instantiated. public class Item implements java.io.serializable private Integer id; private String name; private String description; private String imageurl; private String imagethumburl; private BigDecimal price;... The Item entity class maps to to the ITEM table that stores the item instances. This is is a typical Java Persistence entity object. There are two requirements for an entity: annotating the class with an annotation annotating the primary key identifier

11 Concept highlights: JEE6 feature in Petcatalog Servlet3 [5] Servlet public class RedirectPetcatalog extends HttpServlet {... } Item.java The Servlet 3.0 API focuses on ease of of development by by using the JSR 175 annotations to to enable declarative-style programming. This program qualifies this class as as a Servlet class by by annotation. This annotation not only makes the coding of of servlet classes easier, but also makes deployment descriptors optional for a web application. The web container is is responsible for processing the annotations located in in classes in in the WEB-INF/classes directory, in in a.jar file located in in the WEB-INF/lib directory, or or in in classes found elsewhere in in the application's classpath.

12 Topology WebSphere Application Server ND Machine OS # of CPUs CPU Speed CPU Type RAM (GB) Function W AS Server W indows Ghz INTEL32 2 Single Server server1 WAS V8 Server1 Rational Application Developer V8 GlassFish 3 MySQL server Derby server

13 Applications Pet catalog is a small, simple and open source application, which includes JPA 2.0, EJB 3.1 Light and JSF 2.0 [4]. We also added a servlet (RedirectPetcatalog.java) to this application during our testing, since we wanted to include Servlet 3.0 feature in this application to see whether there are some special issues during migration for Servlet 3.0. The source code package originally is available in the link with name JavaEE 6 pet catalog. But now this link is unavailable, the source code will be packaged with this test report. In this package one more java file RedirectPetcatalog.java has been added under catalog/src/java/controller directory. The diagram on the right illustrates the execution process of Pet catalog application:

14 Migration steps overview [5] WAS: WebSphere Application Server V8 RAD: Rational Application Developer V8

15 Glassfish Application Validation Let's launch the Glassfish Application Validation phase now. Steps at a glance: Mavenize the download project pet catalog. Install Glassfish and MySQL. Validate Glassfish application works well on Glassfish server.

16 Detailed Glassfish Application Validation Mavenize the project. a.create pom.xml (you can download it from link b.get source code packaged with this test report, which includes RedirectPetcatalog.java. c.change index.html - From <meta http-equiv= refresh content= 0,url=app/list.xhtml > to <meta http-equiv= refresh content= 0,url=app/RedirectPetcatalog > d.move the source files according to Maven defaults directory structure (please refer to link or please refer to the graph on the right for moving files). e.or you can skip all steps above, download the whole refactored project with maven default directory from link - But this copy doesn't have RedirectPetcatalog.java. You need to copy it from source code packaged with this test report to directory src/main/controller - Also need to change index.html file according to the step c. f.invoke mvn install. If everything goes well, you will have a catalog.war file After moving files according to maven default directory, whole re-factored project should look like the following graph Newly added servlet for test Need to be changed as step c

17 Detailed Glassfish Application Validation Install Glassfish V3, setup MySQL and install application on Glassfish. a.download Glassfish V3 Open Source Edition b.web Profile from link web.zip, and install it, then start it by asadmin startdomain c.configure DB connection - Install MySQL, create a schema in MySQL called petcatalog,run catalog.sql(included in source code) to create tables, and copy MySQL driver (mysql-connectorjava-xxxx-bin.jar) to Glassfish install DIR/lib. - On Glassfish console( default user/pwd admin/adminadmin), define a MySQL datasource in Glassfish, and a JNDI entry, jdbc/petcatalog. Note: If you have any DB configuration problem, please refer to d.on Glassfish console, install application with catalog.war 3. Verify the application runs successfully. a.verify browser can access application function properly from link Glassfish system>:< your application port>/catalog/app/redirectpetcatalog or click Launch button besides catalog application. b.verify that there is no exception in Glassfish log (Glassfish directory/glassfish/domains/domain1/logs) Verification point 1: The original application work as expected. [Yes]

18 What we just finished

19 Migration Procedures Now that you have finished the Glassfish Application Validation, let's proceed with migration steps. Next steps at a glance: Install WebSphere Application Server V8.0 single server. Install Rational Application Developer V8. Validate Glassfish application works well on WebSphere Application Server V8.0 through RAD.

20 Detailed Migration Procedures Install WebSphere Application Server binaries by using Install Manager on target machine to be used for WebSphere Application Server. Note: If you encounter any problem, please refer to link ns_installation_dist.html 2. Install Rational Application Developer V8 by using Install Manager on target machine. Note: If you encounter any problem, please refer to link

21 Detailed Migration Procedures Set up DB by using WebSphere Application Server embedded DB Derby a.find DB script catalog.sql in download source code package catalog.zip. Run the following command - "<WebSphere Application Server install directory>\derby\bin\embedded\ij.bat" - ij> connect 'jdbc:derby:petcatalog;create=true'; - ij> run '<Directory for unziped catalog.sql>\catalog.sql'; 5. You can create New Project in Rational Application Developer V8 for pet catalog application and Import source code to this project a.create a Dynamic Web Project and input the following - Project name: catalog - Target runtime: WebSphere application Server V8.0 stub - Add project to EAR: check - Context Root: catalog 4. Configure DB connection in WebSphere Application Server Console a.configure JDBC provider with the following parameters - Database type: Derby - Provider type: Derby JDBC Provider - Implementation type: Connection pool data source - Name: Petcatalog Derby JDBC Provider b.configure Data sources for WebSphere Application Server server1 with the following parameters - Data source name: petcatalog - JNDI name: jdbc/petcatalog - JDBC provider: Petcatalog Derby JDBC Provider - Database name: petcatalog c.verify Data source petcatalog works well by clicking Test connection button. b.copy files as follows - Import source code from directory catalog\src\java to catalog->java Resources->src - Import source code from directory catalog\src\conf to catalog->webcontent- >META-INF - Import source code from directory catalog\web to catalog->webcontent

22 Detailed Migration Procedures Add remote WebSphere Application Server to Rational Application Developer a.in the right bottom frame, click Servers tab, and new a server for remote WebSphere Application Server server1. Input the following information. - choose WebSphere Application Server V8.0 option, if only have WebSphere Application Server V8.0 Beta option in the list, you can add your WebSphere Application Server type by clicking on Add... open beside Server runtime environment. - Server's host name: your remote system running server1 - Installation directory in Add... button: your WebSphere Application server installed directory - For local server: keep default value - For remote server: - Manually provide connection setting: SOAP Port number - Application server name: server1 (default value) - Input remote system OS, Server profile path, user and password 7. Run Project a.right click catalog project, then choose run at server. Note: WebSphere JPA provider requests bytecode entity class files enhanced. Bytecode enhancement will be done automatically when we deploy application to WebSphere Application Server. 8. Verify the application runs successfully. a.verify browser can access application function properly from link Glassfish system>:< your application port>/catalog/app/redirectpetcatalog Note: when access Glassfish system>:< your application port>/catalog/app/redirectpetcatalog, this link will be redirected to Glassfish system>:< your application port>/catalog/app/list.xhtml Verify that there is no exception in SystemOut.log and SystemErr.log. By running the steps above and using the Rational Application Developer to assist us during migration, it should not be difficult to migrate this sample application. And also for this application, catalog.war can be deployed to WebSphere Application Server directly after step 4. then user can access it by step 8. Verification point 2: Glassfish Java EE 6 application works as expected on WebSphere Application Server V8.0 after migration [Yes]

23 What we just finished You might use these debugging steps if if you encountered some problems

24 Results Run Glassfish V3 Java EE6 project catalog which includes EJB 3.1, JPA2.0, JFS2.0, Servlet 3.0 Validate that application works properly on Glassfish V3 firstly. [Yes] Migrate catalog application which includes EJB 3.1, JPA2.0, JFS2.0, Servlet 3.0 to WebSphere Application Server V8.0 by using Rational Application Developer V8 Verify application works properly on WebSphere Application Server V8, and all Java EE 6 features works well after migration. [Yes]

25 Summary [2] As expected, we did not face problems when migrating Java EE 6 application from GlassFish V3 to WebSphere Application Server V8.0. The pet catalog application is a small, simple and open source application with Java EE 6 features to serve as an example for practitioners and beginners to the Java EE 6 platform. Those features include Enterprise JavaBeans 3.1, Java Persistence API (JPA) 2.0, JavaServer Faces (JSF) 2.0, Servlet 3.0. We were able to migrate this application successfully without any special steps. Because we had the source code for these applications, we used the strategy to rebuild all applications by importing the source files to Rational Application Developer. Such an approach made the migration process easy to debug problems and easy to deploy in WebSphere Application Server. Also, for this simple application, we were able to migrate it successfully by deploying Glassfish application catalog.war to WebSphere Application Server directly. This migration shows the Java EE6 standards are evolving in a way that all applications will become more compatible and portable among platforms and application server vendors.

26 References [1] IBM WebSphere Application Server V8.0 Beta here/wsasoa/index.shtml [2] WebSphere Application Server V7 Competitive Migration Guild [3] A Sampling of EJB [4] JSF 2.0, JPA, GlassFish and MySQL [5] An Introduction To Servlet html

27 End This page intentionally left blank