Integrating NWDS with a Non-SAP Server (JBoss AS) to Develop and Deploy Java EE Applications

Transcription

1 Integrating NWDS with a Non-SAP Server (JBoss AS) to Develop and Deploy Java EE Applications Applies to: This article applies to SAP NetWeaver Developer Studio, SAP NetWeaver 7.1 CE SP03 PAT0000 Summary The procedure of integrating SAP NetWeaver Developer Studio with a non-sap Server (JBoss AS) is presented. The steps involved in creating EJB, web, enterprise application, and application client projects and deploying them in JBoss Application Server are explained with appropriate screenshots. This would be useful in scenarios where existing or new J2EE applications need to be tested in non-sap servers before being deployed in the SAP NetWeaver Application Server. Author: Seema Thejraj Company: HCL Technologies Limited Created on: 23 August 2006 Author Bio Seema Thejraj is working as an Associate Project Manager in Engineering and R & D services of HCL Technologies Ltd., Chennai SAP AG 1

2 Table of Contents Author Bio...1 Introduction...3 Setting up JBoss Server...3 Prerequisites...3 Configuring the JBoss Server in NWDS...3 Starting the JBoss Server...6 Developing EJB Component...8 Creating an EJB Project...8 EJB Code Sample...13 Class: ContactDTO...13 Class: ContactCache...13 Class: ContactMgrBean...14 Deployment Descriptor...17 ejb-jar.xml...17 jboss.xml...17 EJB Client Code Sample...18 Developing Web Application...19 Creating a new Web Project...19 JSP Code Sample...20 Developing Enterprise Application...22 Creating an EAR Project...22 Publishing J2EE Application...25 Copyright SAP AG 2

3 Introduction This article discusses the steps that are required to develop and deploy an enterprise application using NWDS and JBoss Application Server using a sample Contacts Management scenario. Basic CRUD operations for contacts and some utility classes have been created in the EJB project. List contacts JSP sample has been developed in the Web Project. This sample is not a complete application and is meant only for demonstrating how Java EE applications can be developed and deployed to JBoss. Setting up JBoss Server Prerequisites JDK 1.6.x should be installed JBoss 4.2.x should be installed in local system. Configuring the JBoss Server in NWDS Open the SAP NetWeaver Developer Studio for CE 7.1. Switch to the Server view in the J2EE Perspective. Right click anywhere in the server view. Choose New > Server in the Context Menu that is displayed SAP AG 3

4 Leave the hostname as localhost as JBoss is installed in local system. (If any other hostname is specified only Basic and SAP nodes are shown. All other Non SAP servers are not listed.) Choose the Server type as JBoss v4.2. Click Next. Choose jdk1.6.0_01 for JRE and the JBoss Home folder for the Application Server Directory. Click Next SAP AG 4

5 Leave the default values for the Server Address, Port, JNDI Port and Server Configuration. Click Finish. A JBoss4.2 node is shown in the servers view in the stopped state SAP AG 5

6 Starting the JBoss Server Right click the JBoss server node and click Start. If the JBoss server is started, the state is set to Started SAP AG 6

7 You can verify the server startup success by accessing the URL SAP AG 7

8 Developing EJB Component Creating an EJB Project Right click on the Project Explorer view. Choose New > EJB Project in the context menu that is displayed SAP AG 8

9 Enter the Project Name as AddressBookEJB. Click New for Target Runtime. Choose the runtime type as JBoss v4.2. Click Next SAP AG 9

10 Choose jdk1.6.0_01 for JRE and the JBoss Home folder for the Application Server Directory. Click Finish. Select Default Configuration for JBoss v SAP AG 10

11 Select EJB Module version 3.0 and Java version 5.0 for Project Facets. Click Next. Check Generate Deployment Descriptor option and click Finish SAP AG 11

12 The AddressBookEJB project node is displayed in the Project Explorer view SAP AG 12

13 EJB Code Sample Class: ContactDTO package com.hcl.ab.dto; import java.io.serializable; public class ContactDTO implements Serializable { private static final long serialversionuid = 1L; private String id; private String name; private String id; public ContactDTO(String id, String name, String id) { this.id = id; this.name = name; this. id = id; public String getid() { return id; public void setid(string id) { this.id = id; public String getname() { return name; public void setname(string name) { this.name = name; public String get id() { return id; public void set id(string id) { this. id = id; Class: ContactCache package com.hcl.ab.util; import java.util.hashmap; import java.util.map; import com.hcl.ab.dto.contactdto; public class ContactCache { private static Map<String, ContactDTO> CONTACTS = new HashMap<String, ContactDTO>(); public static ContactDTO findcontact(string contactid) { return CONTACTS.get(contactId); 2008 SAP AG 13

14 public static Map<String, ContactDTO> findallcontacts() { if (CONTACTS.isEmpty()) { ContactDTO contact = new ContactDTO("1", "Tom Sawyer", "tom.sawyer@test.in"); CONTACTS.put(contact.getId(), contact); contact = new ContactDTO("2", "Huck Finn", "huck.finn@test.in"); CONTACTS.put(contact.getId(), contact); return CONTACTS; public static void addcontact(contactdto contact) { CONTACTS.put(contact.getId(), contact); public static void updatecontact(contactdto contact) { CONTACTS.put(contact.getId(), contact); public static ContactDTO removecontact(string contactid) { return CONTACTS.remove(contactId); Class: ContactMgrBean Create an empty interface named ContactMgr. Create a class named ContactMgrBean which implements ContactMgr. Include the annotations for the Stateless bean as shown in the code snippet below. NetWeaver Developer Studio Code Assist is available for annotations as well. package com.hcl.ab.bo; import java.util.map; import javax.ejb.remote; import javax.ejb.stateless; import com.hcl.ab.dto.contactdto; public class ContactMgrBean implements ContactMgr { public void addcontact(contactdto contact) { 2008 SAP AG 14

15 ContactCache.addContact(contact); public void updatecontact(contactdto contact) { ContactCache.updateContact(contact); public ContactDTO removecontact(string contactid) { return ContactCache.removeContact(contactId); public ContactDTO findcontact(string contactid) { return ContactCache.findContact(contactId); public Map<String, ContactDTO> findallcontacts() { return ContactCache.findAllContacts(); 2008 SAP AG 15

16 Right click the methods in the ContactMgrBean. Choose EJB methods > Add to Remote Interfaces. The method gets added to the Remote interface. Repeat the same for all methods SAP AG 16

17 Deployment Descriptor ejb-jar.xml Include the following snippet in ejb-jar.xml <enterprise-beans> <session> <ejb-name>contactmgrbean</ejb-name> <mapped-name>contactmgrbean</mapped-name> <business-remote>com.hcl.ab.bo.contactmgr</business-remote> <ejb-class>com.hcl.ab.bo.contactmgrbean</ejb-class> <session-type>stateless</session-type> <transaction-type>container</transaction-type> </session> </enterprise-beans> <assembly-descriptor> <container-transaction> <method> <ejb-name>contactmgrbean</ejb-name> <method-name>*</method-name> </method> <trans-attribute>supports</trans-attribute> </container-transaction> </assembly-descriptor> jboss.xml Create a file called jboss.xml. Include the following snippet. <jboss> <enterprise-beans> <session> <ejb-name>contactmgrbean</ejb-name> <jndi-name>contactmgrbean</jndi-name> </session> </enterprise-beans> </jboss> 2008 SAP AG 17

18 EJB Client Code Sample The following snippet contains the Client code that accesses the ContatcMgrBean. This sample can be run directly from the NWDS IDE after the application has been published package com.hcl.ab.client; import java.util.properties; import javax.naming.context; import javax.naming.initialcontext; import javax.naming.namingexception; import com.hcl.ab.bo.contactmgr; import com.hcl.ab.dto.contactdto; public class ContactMgrClient { public static String CONTACT_BEAN = "ContactMgrBean"; public static String INITIAL_CONTEXT_FACTORY = "org.jnp.interfaces.namingcontextfactory"; public static String PROVIDER_URL = "jnp://localhost:1099"; public static void main(string args[]) { Properties properties = new Properties(); properties.setproperty(context.initial_context_factory, INITIAL_CONTEXT_FACTORY); properties.setproperty(context.provider_url, PROVIDER_URL); try { Context ctx = (Context) new InitialContext(properties); ContactDTO contact = new ContactDTO("3", "Arihant", "arihant@tirt.in"); ContactMgr contactmgr = (ContactMgr) ctx.lookup(contact_bean); contactmgr.addcontact(contact); System.out.println(contactMgr.findContact("1").getName()); catch (NamingException e) { e.printstacktrace(); 2008 SAP AG 18

19 Developing Web Application Creating a new Web Project Right click on project explorer view and choose New > Dynamic Web Project. Enter Context Root as AddressBookWeb. Check Generate Deployment Descriptor option. Click Finish SAP AG 19

20 The newly created AddressBookWeb project is displayed in the Project Explorer. JSP Code Sample package com.hcl.ab.client; language="java" contenttype="text/html; charset=utf-8" pageencoding="utf-8" import="javax.naming.initialcontext, com.hcl.ab.bo.contactmgr, com.hcl.ab.dto.contactdto, java.util.iterator,java.util.collection"%> <%!private ContactMgr contactmgr = null; private static String CONTACT_MGR_BEAN = "ContactMgrBean"; public void jspinit() { try { InitialContext ctx = new InitialContext(); contactmgr = (ContactMgr) ctx.lookup(contact_mgr_bean); catch (Exception e) { e.printstacktrace(); %> <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8"> <title>insert title here</title> </head> <body> <table border="1"> 2008 SAP AG 20

21 <% Collection contacts = contactmgr.findallcontacts().values(); for (Iterator contactiter = contacts.iterator(); contactiter.hasnext();) { ContactDTO contact = (ContactDTO) contactiter.next(); %> <tr> <td><%=contact.getname()%></td> <td><%=contact.get id()%></td> </tr> <% %> </table> </body> </html> 2008 SAP AG 21

22 Developing Enterprise Application Creating an EAR Project Right click on project explorer view. Choose New > enterprise Application Project SAP AG 22

23 Enter the Project name as AddressBook. Choose JBoss v4.2 2 as the Target Runtime. Choose Default Configuration for JBoss v4.2 2 for Configurations. Click Next. Select Project Facet as EAR 5.0. Click Next SAP AG 23

24 Add AddressBookEJB and AddressBookWeb modules to the EAR. Click Finish. The AddressBook EAR project is created successfully. The EAR deployment descriptor application.xml contains ejb and web modules SAP AG 24

25 Publishing J2EE Application Right click the JBoss node in Server View. Choose Add and Remove Projects in the context menu. Select the AddressBook EAR project. Click Add SAP AG 25

26 The AddressBook project is moved to the configured projects list. The AddressBook project is displayed under the JBoss node SAP AG 26

27 Right click on the JBoss 4.2 node. Click Publish. The application gets deployed in the server. Access the URL The List contacts page is displayed with the contacts SAP AG 27

28 Copyright 2008 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iseries, pseries, xseries, zseries, System i, System i5, System p, System p5, System x, System z, System z9, z/os, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, Informix, i5/os, POWER, POWER5, POWER5+, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mysap, mysap.com, xapps, xapp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. These materials are provided as is without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. SAP shall not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials. SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within these materials. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third party web pages nor provide any warranty whatsoever relating to third party web pages. Any software coding and/or code lines/strings ( Code ) included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent SAP AG 28