Leverage Rational Application Developer v8 to develop OSGi application and test with Websphere Application Server v8 Author: Ying Liu cdlliuy@cn.ibm.com Date: June,29 2011 2010 IBM Corporation
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.
Trademarks and Service Marks The following terms are trademarks of the IBM Corporation in the United States or other countries or both: IBM WebSphere IBM WebSphere Application Server IBM Rational Application Developer Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. OSGi is a trademark or a registered trademark of the OSGi Alliance in the United States, other countries, or both. Other company, product and service names may be trademarks or service marks of others.
Executive Summary The OSGi Applications support in WebSphere Application Server (WAS) version 8.0 brings the modularity, dynamism, and versioning of the OSGi service platform to enterprise web application developers. Rational Application Developer (RAD) version 8.0 contains a selection of views, wizards, and editors which are customized to for OSGi developers. This test scenario verified that OSGi application support in WAS and RAD work properly when a new version of the Web application bundle is developed and published, and that operations assistance for exporting and installing works properly.
Audience This report is intended for developers and administrators who want to improve management and operational capabilities over OSGi application development and installation using RAD and WebSphere Application Server.
Scenario Description Objective: This test scenario will verify the OSGi application support in RAD V8.0 and WebSphere Application Server. It ensures that the OSGi application works properly when a new version of a web application bundle is added to the existing OSGi application, even when the new bundle is developed with third-party framework. The scenario will also verify that OSGi features in RAD tool, such as develop, publish, import and export functions, work properly.
Concept Highlight OSGi - Povides standardized primitives to allow applications to construct small reusable components called bundles Bundle - A bundle is a Java archive (JAR) or web application archive (WAR) file with standard OSGi metadata that describes aspects of the bundle, including the Java packages that the bundle exports, the Java packages that the bundle requires, and the bundle version. EBA - An enterprise bundle archive (EBA) file contains a set of OSGi bundles that are deployed as a single OSGi application, and that are isolated from other OSGi applications. CBA - A CBA is a zip archive with a.cba file extension. It can either directly contain OSGi bundles or reference bundles that are hosted in the internal bundle repository. WAB - A web application bundle (WAB) is a bundle that contains a web application and that can be deployed in an OSGi container. A WAB is an OSGi bundle version of a web application archive (WAR) file. Bundle Life Cycle INSTALLED STARTING start RESOLVED ACTIVE stop UNINSTALLED STOPPING
Topology WebSphere Application Server This scenario will require one personal computer to install Rational Application Developer(RAD), and one WebSphere Application Server (WAS) stand-alone environment that will originally consist of an application server. We also need a DB2 database server for this scenario. For reference, a sample Topology used in IBM internal test work: OS # of CPUs CPU Speed CPU Type RAM (GB) Function WinXP 2 2.6 Ghz INTEL32 4 IDE Solaris 10 2 1.4 GHz SunSparc 2 Node1/server1 Red Hat Enterprise Linux Server 4 2.6 Ghz INTEL32 20 Database RAD Applicatio n server DB2 server
Applications OSGi Application XFS (internal test application) Use OSGi Programming Model Sample: XFS EBA APPLICATION.MF Application-SymbolicName The unique symbolic name of the OSGi application, using similar package notation to Java. Application-Version The version of the application, using OSGi syntax for a bundle version. Application-Name The name of the application. Application-Content A list of bundles and the acceptable range of OSGi version specifications that are included in the application. The application manifest file contains metadata that enables the OSGi Framework to process the modular aspects of the bundles. Based on XFS application, new bundles will be developed using Spring Framework in this scenario, including: Web Tier (JEE Web Application) Business Tier (Aries Application, EBA) Persistence Tier(Aries Application using JPA)
Installation and Configuration Let's launch the installation and configuration phase now. Please use IBM Installation Manager to perform the following installation Installation Manager is a single installation program that can use remote or local software repositories to install, modify, or update new products. It determines and shows available packages including products, fix packs, interim fixes, and so on checks prerequisites and interdependencies, and installs the selected packages. You also use Installation Manager to easily uninstall the packages that it installed. Steps at a glance: Install WebSphere Application Server, create required profiles. Install RAD and create connection to the profile of Application Server. Notes: IBM installation manager version 1.4.4 is used for installation. IBM RAD version 8.0.2 is used for JEE6 application development & test with WAS v8. Download links: Installation manager RAD trial version WAS Network deployment trial version
Detailed Installation and Configuration - 1 1. These steps assume the database server you are using is already installed and configured. 2. Install WebSphere Application Server Network Deployment (ND) binaries on the machine to be used for WebSphere application server node by Installation manager. If you don't have experience on WebSphere Application Server installation with Installation Manager, please refer to Installing V7 Feature Packs, Installation Manager test report. OR, refer to WAS v8 Info center Installation topic to get more detail information. 3. Create required profile on WebSphere Application Server. An application server profile is recommended. The profile management tool will be launched after WebSphere Application Server is installed, and guide you to create a profile.
Detailed Installation and Configuration - 2 4. Install RAD by Installation Manager, and select necessary package to support Java EE application development In Installation Manager : Select the option Tools for developing application without a local server installation in case you need a remote application server to deploy applications. Select the option JavaTM EE and Web services development tools & OSGi development tools Refer to the sample screen shot on the right or refer to RAD info center installation topic for details. 5. Define a new remote server in RAD Go to J2EE Perspective --> Servers -> New Select the server type with WebSphere Application Server v8.0 Beta -> Input host name and SOAP port of the application server Click Finish, and Save. You can find the SOAP port from WAS Admin Console->WebSphere application servers->server1- >Communications->Ports
Procedures Now, you have finished the installation and configuration phase for Application Server and RAD, let's proceed with execution. Next steps at a glance: To use the third-party OSGi framework - Spring Dynamic Modules for OSGi (step 1-5) Import Plug-ins and Fragments into RAD workspace from Spring library files Create OSGi Composite Bundle Project to contain Spring bundles Export CBA file to install the required bundles into Internal bundle repository of WebSphere Application Server To work on existing XSF applications and develop new function in web module. (step 6-9) Import existing XFS.eba into RAD Create OSGi Bundle Project for the application to develop web tier bundles in RAD and deploy the EBA to application server. To create new OSGi applications and develop functions. (step 11-16) Create OSGi Application Project in RAD Create OSGi Bundle Project for the application to develop persistence/business/web tier bundles in RAD and deploy the EBA to application server.
Detailed Procedures 1. Download Spring library file from http://www.springsource.org/osgi 2. Open wizard to import plug-ins and fragments in Rational Application Developer (RAD) File Import Plug-in Development Plug-ins and Fragments Then, Select required library files from the downloaded Spring library files Select the Directory Browse the directory where contains spring lib Select needed library files add click Finish
Detailed Procedures 3. Create OSGi Composite Bundle Project to contain Spring bundles In RAD, File New OSGi OSGi Composite Bundle Project, click Next Input Project name, click Next Enter OSGi Bundles Selection Page to Select needed Spring bundles 4. Export CBA file from RAD workspace Go to File Export OSGi OSGi Composite Bundle(CBA), click Next Browse the target file and select Bundles to include, click Finish
Detailed Procedures 5. Install the exported CBA file into Internal bundle repository of WebSphere Application server Open the Admin Console of the application server Go to Environment -> OSGi bundle repository ->Internal bundle repository. Click 'New...' Browse the 'Local file system Specify path' in 'Path to the asset' to select the exported CBA file in step 4. Click 'OK'. Verify the bundles imported into the repository by checking the bundle list in the 'Internal bundle repository'
Detailed Procedures 6. Import existing application XFS.eba to RAD In RAD, go to File->Import Select OSGi OSGi Application (EBA) Fill EBA file name, and select bundles to include. The existing XFS application will be imported into RAD. Now, you can work on XFS application to develop new OGSi bundles in RAD
Detailed Procedures 7. Create new web tier bundles Go to File->New->OSGi->OSGi Bundle project, input bundle name following java package name style Select Add Web support: Web 2.5 Select Add bundle to application, and choose XFS application Click Next, then Next if you do not need special settings In the Web Module page, modify Context-root if necessary. Or modify the context-root later in MANIFEST.MF Bundle-ClassPath Web Application Context Root
Detailed Procedures 8. Modify MANIFEST.MF of web tier bundles Open Manifest of com.ibm.pt.xfs.webisv bundle in Plug-in Manifest Editor Add more imported packages in Dependencies tab.
Detailed Procedures 9. Develop new web application using Spring framework 10. Publish the new XFS application from RAD to WAS Open the directory of the application bundle in the Enterprise explorer of RAD workplace, com.ibm.pt.xfs.app in our case. Open the application manifest file. You will see the Contained Bundles in the list. Select and remove all bundles those have been installed into OSGi bundle repository of the application server in Step 5. Go to Windows->Show View->Servers, right-click server name and click 'Add and remove...' in to popped menu to publish the application to application server Access your application using browser : http://yourserver:port/<context-root>/login.jsp Remove all the bundles which already installed in the application server runtime
Detailed Procedures Note: If you will create a new OSGi application, please ignore previous step 6-10, and follow step 11-16. 11. Create new OSGi Application Project in RAD. Go to File->New->OSGi->OSGi Application Project, input application name Select the Target runtime, WebSphereV8.0 Beta stub If you can not find the needed Target runtime, you can select New Runtime and configure the new Runtime setting OR Click Windows->Preferences->Server->Runtime Enviroment, click Add... to define new Runtime.
Detailed Procedures 12. Create persistence tier bundles Go to File->New->OSGi->OSGi Bundle project, input bundle name following java package name style Select Add persistence support: JPA 2.0 Select Add bundle to application which created in step 11 Click Next and Next if you do not need special settings Select RAD JPA2.0 platform and Library Provided by Target Runtime You can select the connected database in Connection if you need Click Finish
Detailed Procedures 13. Create business tier bundles. Similar to the step 12 without selecting any options of 'Web 3.0' nor 'JPA 2.0' If you need to enable more facets, select Custom in configuration and click Advanced...
Detailed Procedures 14. Create web tier bundles. Similar to the step 12, but just select the option 'Add Web Support: Web 2.5 15. Modify MANIFEST.MF of OSGi bundles to import Spring library files. Similar as we did in step 8. 16. Develop your application and Publish from RAD to WAS Similar as we did in step 9 & step 10.
Results Import Plug-ins and Fragments into RAD workspace from SpringMVC library files. Validate that the bundles have no error messages. [Yes] Create OSGi Composite Bundle Project to contain SpringMVC bundles. Verify that the composite bundle project can be created and added Spring bundles. [Yes] Export CBA file to install the required bundles into Internal bundle repository of application server. Export CBA file from the OSGi Composite Bundle Project. Verify that the exported.cba file contains all added Spring jar files. [Yes] Install the CBA file into 'Internal bundle repository' of application server. Verify that the installed bundles are listed in the repository. [Yes] Import existing OSGi application into RAD, and create OSGi Bundle Project for the application to develop persistence/business/web tier bundles in RAD and deploy the EBA to application server Verify that the projects can be built as expected. [Yes] Verify that the application can be published to the application server and the web page can be accessed from web browser, which run as exprected. [Yes]
Summary The OSGi Applications support in WebSphere Application Server brings the modularity, dynamism, and versioning of the OSGi service platform to enterprise web application developers. You can add your required framework library files to the bundle repository of application server as shared bundles. You can use RAD to develop complex OSGi applications and publish them to application server
References [1] IBM WebSphere Application Server Version 8.0.0 Information Center http://publib.boulder.ibm.com/infocenter/wasinfo/v8r0/index.jsp [2] IBM Rational Application Developer Version 8.0.1 Information Center http://publib.boulder.ibm.com/infocenter/radhelp/v8/index.jsp [3] IBM Education Assistant http://publib.boulder.ibm.com/infocenter/ieduasst/v1r1m0/topic/com.ibm.iea.wasf posgi/plugin_coverpage.html?resultof=%22%6f%73%67%69%22%20 [4] If you want more test reports of WebSphere Application Server, please refer to: https://www.ibm.com/developerworks/mydeveloperworks/wikis/home? lang=en#/wiki/websphere%20application%20server%20test%20team
End This page intentionally left blank