SDN Community Contribution

Transcription

1 Step by step guide to develop a module for reading file name in a sender file adapter SDN Community Contribution (This is not an official SAP document.) Disclaimer & Liability Notice This document may discuss sample coding or other information that does not include SAP official interfaces and therefore is not supported by SAP. Changes made based on this information are not supported and can be overwritten during an upgrade. SAP will not be held liable for any damages caused by using or misusing the information, code or methods suggested in this document, and anyone using these methods does so at his/her own risk. SAP offers no guarantees and assumes no responsibility or liability of any type with respect to the content of this technical article or code sample, including any liability resulting from incompatibility between the content within this document and the materials and services offered by SAP. You agree that you will not hold, or seek to hold, SAP responsible or liable with respect to the content of this document.

2 Step by step guide to develop a module for reading file name in a sender file adapter Applies To: SAP NW 04 XI 3.0 Article Summary This is a step by step guide for developing, deploying and configuring a module exit to read the file name in a sender file adapter. This module will get the file name and add it as an element to the XML Payload By: Krishnakumar Ramamoorthy (KK) Deloitte Consulting Title: Product Management Date: 05 May 2005 Table of Content Step by step guide to develop a module for reading file name in a sender file adapter... 2 Applies To:... 2 Article Summary... 2 Table of Content... 2 Introduction... 3 Prerequisites... 3 Step by Step procedure... 3 Copy the required JAR files from XI Server... 3 Set up class path variables in NW Developer Studio... 4 Create an EJB module project... 4 Create an EJB module bean... 5 Implement the bean... 7 Edit the bean deployment descriptors ejb-jar.xml... 9 Create bean archive Create Enterprise application project Create references in the Enterprise Application Project Build Application archive and deploy Appendix Disclaimer & Liability Notice... 17

3 Introduction An integration scenario involving a sender file adapter, it may be necessary to know the name of the file which was processed. This is particularly true when the files are picked up using * and the file name is to be used in the condition editor for receiver determination. This can be accomplished by developing a module processor exit bean. Please read SAP Help documentation for more information on Module Processor and extending the module chain. Prerequisites SAP XI 3.0 SP 9 or above SAP Netweaver Developer Studio JDK 1.4 Step by Step procedure Copy the required JAR files from XI Server The following JAR files are required to develop the module. The jar files need to be externally referenced in the application. Copy these jars files from the provided location in the XI server, to you local system. Jar Name aii_af_ms_spi.jar aii_af_cci.jar aii_af_ms_api.jar aii_af_trace.jar aii_af_mp.jar aii_utilxi_misc.jar aii_adapter_xi_svc.jar aii_af_cpa.jar aii_af_svc.jar aii_util_xml.jar ejb20.jar exception.jar Location <serverdir>*\bin\ext\com.sap.aii.af.lib\ <serverdir>*\bin\ext\com.sap.xi.util.misc\ <serverdir>*\bin\services\ com.sap.aii.adapter.xi.svc\ <serverdir>*\bin\services\ com.sap.aii.af.cpa.svc\ <serverdir>*\bin\services\ com.sap.aii.af.svc\ <serverdir>*\bin\ext\com.sap.xi.util.xml\ \usr\sap\j2e\jc00\j2ee\j2eeclient <serverdir> -> If XI has been installed on Windows under drive D, then server directory will look like : d:\usr\sap\<sid>\<instance>\j2ee\cluster\server0\. <SID> -> System ID, <INSTANCE> -> J2EE Instance. Example: d:\usr\sap\xi3\dvebmgs00\j2ee\cluster\server0\ While saving the jar files in the local system (for e.g. c:\jarfiles), suggestion is to follow the below pattern C:\jarfiles\com.sap.aii.af.lib\aii_af_ms_spi.jar C:\jarfiles\com.sap.xi.util.misc\aii_utilxi_misc.jar

4 Set up class path variables in NW Developer Studio We need to set up a class path variable for referencing these.jar files in our application. Open up NW Dev Studio and follow the below steps Choose menu Window->Preferences. In the popup window, choose Java->Classpath Variables. Add a new variable by clicking Provide an arbitrary name in the Name field. For e.g. SAP_USER_ADD_LIBS. (If the variable is already available, edit the same) In the Path field, choose the folder where you have stored all the jar files from step 1. Use the button to choose the folder. Confirm your entries by clicking OK. Create an EJB module project The module we are going to develop is an EJB. Hence, in the NW Dev Studio, we need to create an EJB module project first. Choose File->New->Project. In the popup screen, choose J2EE. From the right frame, choose, EJB Module Project. Click. Provide a project name. In our example, we will say SampleFileAdatperModule. Leave the Check box Use Default checked. This will place all your developments in the default workspace.

5 Click to confirm your entries. This will create the project as shown below Now we have to set up reference to the jar files in our project. To do this, choose the J2EE Explorer view in your left frame if not already chosen and then select the project, right click and choose Properties In the popup window, choose Java build path. On the right frame, choose tab libraries. Click on button In the next window, choose SAP_USER_ADD_LIBS and click. Please note that this is the variable we created in the previous steps. Select the required jar files and click confirm all by clicking OK. This will create the build paths. Make sure that all the jar files are included this way. Create an EJB module bean We now create the module bean under the EJB module project created above. Follow the below steps for the same Choose the folder ejbmodule in the J2EE Explorer view and from the context menu (right click), choose New->EJB.

6 In the next screen, provide the following information EJB Name -> A name for your bean. For example: GetFileName EJB Project -> SampleFileAdatperModule Bean Type -> Stateless Session Bean Default EJB Package -> Some arbitrary package name. For e.g. com.kk.filemodule. Remove the check box generate default interfaces. We do this, because we are going to have only a local interface for this bean. Click Next In the next screen, remove the check box on Remote Interfaces and click Next. Click to confirm your entries. Now, in the J2EE explorer, expand the folder ejb Module ->com->kk->filemodule. You will find a file named GetFileNameBean.java. This is where we are going to code our main module.

7 Please refer SAP Help documentation and API documentation from the samples provided under Adapter development. Implement the bean Below is provided, the code snippet for implementing the bean. The full code is provided in the appendix. First, we need to import the referenced classes. // Classes for EJB import javax.ejb.createexception; import javax.ejb.sessionbean; import javax.ejb.sessioncontext; // Classes for Module development & Trace import com.sap.aii.af.mp.module.module; import com.sap.aii.af.mp.module.modulecontext; import com.sap.aii.af.mp.module.moduledata; import com.sap.aii.af.mp.module.moduleexception; import com.sap.aii.af.ra.ms.api.message; import com.sap.aii.af.service.trace.trace; import java.util.hashtable; // XML parsing and transformation classes import javax.xml.parsers.*; import org.w3c.dom.*; import java.io.inputstream; import java.io.bytearrayoutputstream; import com.sap.aii.af.ra.ms.api.xmlpayload; import javax.xml.transform.*; import javax.xml.transform.source; import javax.xml.transform.result; import javax.xml.transform.dom.domsource; import javax.xml.transform.stream.streamresult; The bean class MUST implement SessionBean and Module interface. public class GetFileNameBean implements SessionBean, Module { Add a business method process(). This method will be called by the Module Processor.

8 public ModuleData process(modulecontext modulecontext, ModuleData inputmoduledata) throws ModuleException { Read the XML payload and message for getting the needed data. Object obj = null; // Handler to get Principle data Message msg = null; // Handler to get Message object String filename = null; // File Name which is being processed try { obj = inputmoduledata.getprincipaldata(); msg = (Message) obj; // Get the Supplemental data which is available as hash table Hashtable mp = (Hashtable) inputmoduledata.getsupplementaldata ("module.parameters"); // Get the file name which is being processed if (mp!= null) filename = (String) mp.get("filename"); catch (Exception e) { // Throw any exceptions ModuleException me = new ModuleException(e); throw me; Now, we have read the file name, we now have to get the XML payload and add this file name at the appropriate place in the XML. For parsing and adding new element, we use DOM. try{ // Get the XML Payload XMLPayload xmlpayload = msg.getdocument(); DocumentBuilderFactory factory; factory = DocumentBuilderFactory.newInstance(); DocumentBuilder builder = factory.newdocumentbuilder(); // Parse the XML Payload Document document = builder.parse((inputstream) xmlpayload.getinputstream()); // Get the XML payload root element Element rootnode = document.getdocumentelement(); if(rootnode!= null){ // Create an element node for with name FileName

9 Element childelement = document.createelement("filename"); // populate the Filename element with the value of the filename obtained from supplement data childelement.appendchild // Append the newly created element to the root (document.createtextnode(filename)); rootnode.appendchild(childelement); Now, we have to transform our XML document in DOM stream to Byte stream so that it can be assigned back to the XML payload. TransformerFactory tfactory = TransformerFactory.newInstance(); Transformer transformer = tfactory.newtransformer(); Source src = new DOMSource(document); // DOM source is our DOM doc // Create a new instance of ByteArrayOutputStream ByteArrayOutputStream mybytes = new ByteArrayOutputStream(); Result dest = new StreamResult(myBytes); // Transform the DOM source to Stream Result (ByteArrayOutputStream) transformer.transform(src,dest); // Get the byte array for the payload byte[] doccontent = mybytes.tobytearray(); if(doccontent!= null){ // Set the content for xmlpayload and the principal data of ModuleData to be returned. xmlpayload.setcontent(doccontent); inputmoduledata.setprincipaldata(msg); You can add additional tracing information for error handling, which out of scope of this document. Edit the bean deployment descriptors ejb-jar.xml From the J2EE Explorer tab, double click on node ejb-jar.xml. On the right side pane, choose tab source and replace the home, remote, local-home and local nodes as below <enterprise-beans> <session> <ejb-name>getfilenamebean</ejb-name> <home>com.sap.aii.af.mp.module.modulehome</home> <remote>com.sap.aii.af.mp.module.moduleremote</remote>

10 <local-home>com.sap.aii.af.mp.module.modulelocalhome</local-home> <local>com.sap.aii.af.mp.module.modulelocal</local> <ejb-class>com.kk.filemodule.getfilenamebean</ejb-class> <session-type>stateless</session-type> <transaction-type>container</transaction-type> </session> </enterprise-beans> Create bean archive Now, we have to create an archive (.jar) for our bean. In the J2EE explorer, right click on the EJB project (KKSampleAdapterModule) and choose option Build Archive This will add a.jar file to the EJB module project. Create Enterprise application project To deploy our bean, we need to create an enterprise application project. Follow the below steps Menu File -> New -> Project -> J2EE -> Enterprise Application Project In the next screen, provide an arbitrary project name. In our example, we will give it a name com.kk.filemodule. Click Next and choose EJB Module project as Referenced Projects.

11 Confirm your entries by clicking Finish Create references in the Enterprise Application Project The deployed application need to reference the libraries and services in the deployed J2EE engine. In the created enterprise application project, double click on the node application-j2eeengine.xml. On the right hand pane, choose the tab General Click on the References folder and click Add In the next popup screen, click on button Create New Provide the following information Reference Target :- com.sap.aii.af.lib Reference Type :- weak Reference target type :- Library Provider Name :- sap.com Repeat the above steps with the below values for other references Reference Target Reference Reference Provider Name Type Target type com.sap.xi.util.misc Weak Library sap,com com.sap.aii.adapter.xi.svc Weak Service sap.com com.sap.aii.af.svc Weak Service sap.com com.sap.aii.af.cpa.svc Weak Service sap.com com.sap.xi.util.xml Weak Library sap.com Now you should have six references created as shown

12 Once done, save the changes Build Application archive and deploy Now we have to build an.ear file and deploy the same to the J2EE engine. Right click on the Enterprise application project. In our example, it is com.kk.filemodule. Click on Build Application Archive Once the.ear file has been generated, right click on it and choose Deploy to J2EE Engine. You may need the SDM password for deploying. Please note that the application will be deployed to the engine provided under preferences in your NW Developer Studio. To verify the same, follow the menu path Window -> Preferences -> SAP J2EE Engine. On the right hand pane, check the entries. You can either provide a local J2EE engine or a remote host.

13 Once successfully deployed, you should be able to use this bean in your communication channel. In the communication channel, the module is referred as localejbs/jndi Name. In our case, it will be /sap.com/com.kk.filemodule/getfilenamebean. This module should be placed before the module localeejbs/callsapadapter in the sender file communication channel. Appendix package com.kk.filemodule; // Classes for EJB import javax.ejb.createexception; import javax.ejb.sessionbean; import javax.ejb.sessioncontext; // Classes for Module development & Trace import com.sap.aii.af.mp.module.module; import com.sap.aii.af.mp.module.modulecontext; import com.sap.aii.af.mp.module.moduledata; import com.sap.aii.af.mp.module.moduleexception; import com.sap.aii.af.ra.ms.api.message;

14 import com.sap.aii.af.service.trace.trace; import java.util.hashtable; // XML parsing and transformation classes import javax.xml.parsers.*; import org.w3c.dom.*; import java.io.inputstream; import java.io.bytearrayoutputstream; import com.sap.aii.af.ra.ms.api.xmlpayload; import javax.xml.transform.*; import javax.xml.transform.source; import javax.xml.transform.result; import javax.xml.transform.dom.domsource; import javax.xml.transform.stream.streamresult; /** <{com.kk.filemodule.getfilenamelocal> <{com.kk.filemodule.getfilenamelocalhome> Container */ public class GetFileNameBean implements SessionBean, Module { public static final String VERSION_ID = "$Id: //tc/aii/30_rel/src/_adapters/_sample/java/com/sap/aii/af/sample/mod ule/getfilenamebean.java#1 $"; private static final Trace TRACE = new Trace(VERSION_ID); private SessionContext mycontext; public void ejbremove() { public void ejbactivate() { public void ejbpassivate() {

15 public void setsessioncontext(sessioncontext context) { mycontext = context; public void ejbcreate() throws CreateException { public ModuleData process(modulecontext modulecontext, ModuleData inputmoduledata) throws ModuleException { Object obj = null; Message msg = null; String filename = null; try { obj = inputmoduledata.getprincipaldata(); msg = (Message) obj; Hashtable mp = (Hashtable) inputmoduledata.getsupplementaldata("module.parameters"); mp.get("filename"); if (mp!= null) filename = (String) catch (Exception e) { ModuleException me = new ModuleException(e); throw me; try{ XMLPayload xmlpayload = msg.getdocument(); DocumentBuilderFactory factory; factory = DocumentBuilderFactory.newInstance(); DocumentBuilder builder = factory.newdocumentbuilder(); Document document = builder.parse((inputstream) xmlpayload.getinputstream()); Element rootnode = document.getdocumentelement(); if(rootnode!= null){ Element childelement = document.createelement("filename");

16 childelement.appendchild(document.createtextnode(filename)); rootnode.appendchild(childelement); // Transforming the DOM object to Stream object. TransformerFactory tfactory = TransformerFactory.newInstance(); Transformer transformer = tfactory.newtransformer(); Source src = new DOMSource(document); ByteArrayOutputStream mybytes = new ByteArrayOutputStream(); Result dest = new StreamResult(myBytes); transformer.transform(src,dest); byte[] doccontent = mybytes.tobytearray(); if(doccontent!= null){ xmlpayload.setcontent(doccontent); inputmoduledata.setprincipaldata(msg); catch (Exception e) { ModuleException me = new ModuleException(e); throw me; return inputmoduledata;

17 Disclaimer & Liability Notice This document may discuss sample coding, which does not include official interfaces and therefore is not supported. Changes made based on this information are not supported and can be overwritten during an upgrade. SAP will not be held liable for any damages caused by using or misusing of the code and methods suggested here, and anyone using these methods, is doing it under his/her own responsibility. SAP offers no guarantees and assumes no responsibility or liability of any type with respect to the content of the technical article, including any liability resulting from incompatibility between the content of the technical article and the materials and services offered by SAP. You agree that you will not hold SAP responsible or liable with respect to the content of the Technical Article or seek to do so. Copyright 2004 SAP AG, Inc. All Rights Reserved. SAP, mysap, mysap.com, xapps, xapp, 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, service names, trademarks and registered trademarks mentioned are the trademarks of their respective owners.