Question Re: Java Mapping adding BOM to a file in Technology Q&A

Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 15:42:12 GMT

Hi Experts,

I created a Java mapping jar using NWDS as below, but I applied to my Operation Mapping, but it didn't work, the BOM didn't add to the beginning of the file. Is there anything missing?

1. Create the Java project and .java class

2. Export the Jar file

Thanks

Blue

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 15:53:19 GMT

Hi Blue,

Did you add this java mapping after the messages mapping in the operation mapping?

Regards,

Praveen.

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 15:56:55 GMT

Hi Praveen,

I did as below. I also imported all the libraries followed what is stated in the youtube in the link . Not sure what is missing

Thanks

Blue

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 16:24:06 GMT

Hi Blue,

Save the out mapping result to a file, it will create schema.zip and extract it then you will get instance.xml.

Open this file in Notepad++, open hex editor plugin to see the BOM characters.

Regards,

Praveen.

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 16:46:21 GMT

Hi Praveen,

I output the data to a .txt file and opened the file, but don't see BOM at the beginning of the file?

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 17:03:46 GMT

Mapping editor is not displaying the BOM characters when you copy those characters are not copied, download the file and open it in notepad++ like above it will show the characters

Re: Java Mapping adding BOM to a file

Ryan-Crosby — Wed, 17 Feb 2016 17:05:03 GMT

Hi Blue,

What text editor are you using? Notepad++ for instance will show the encoding as UTF-8-BOM instead of UTF-8 at the bottom right of the screen instead of showing the characters.

Regards,

Ryan Crosby

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 18:33:51 GMT

Hi Praveen,

I opened the file in Hex viewer in Notepad++, still don't see BOM

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 18:36:07 GMT

Hi Ryan,

I opened the file in Notepad++, it shows it is UTF-8 only as below, not UTF-8-BOM

Is the java mapping class not correct or what is the problem?

Blue

Re: Java Mapping adding BOM to a file

Ryan-Crosby — Wed, 17 Feb 2016 18:38:59 GMT

Hi Blue,

I tested that same example of code in Eclipse and it worked - in the past the only thing I have seen that may affect you is if you forget to call flush and close on the output stream before the end of your Java mapping.

Regards,
Ryan Crosby

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 19:44:45 GMT

Hi Ryan,

I also have Modules used in my SFTP, would you think that will impact the Java mapping?

Thanks
Blue

Re: Java Mapping adding BOM to a file

Ryan-Crosby — Wed, 17 Feb 2016 19:47:05 GMT

Hi Blue,

It certainly could - what modules are you using in the SFTP and what configurations are setup for those?

Regards,

Ryan Crosby

Re: Java Mapping adding BOM to a file

Former Member — Wed, 17 Feb 2016 23:09:08 GMT

Sorry Ryan.

I am confusing myself here. I am just sending to the file to PI directory for testing, so just using file adapter and content conversion, not testing SFTP yet.

Even with content conversion still don't see the BOM byte, and I added flush and close output stream as well.

Re: Java Mapping adding BOM to a file

stefan_grube — Thu, 18 Feb 2016 05:50:41 GMT

When you create a BOM with Java Mapping, this BOM is in front of the XML payload only. After content conversion, the BOM is not available anymore. Why do you need a BOM? I have never needed any BOM for any customer.

Re: Java Mapping adding BOM to a file

yeeloon-khoo — Thu, 18 Feb 2016 12:56:07 GMT

Hi Blue,

If you are using standard File adapter, test without content conversion first, see if the BOM characters appear in Notepad++?

The working solution I developed before for seeburger SFTP adapter, is build a custom module for BOM, similar to your code.

Don't use built-in FCC, instead use MessageTransformationBean, then followed by BOM module, it should work.

Regards,

Yee Loon

Re: Java Mapping adding BOM to a file

Former Member — Thu, 18 Feb 2016 19:02:47 GMT

Thank you Stefan.

I thought that solution would add BOM to the beginning of my text file in the receiver end, but It didn't, apparently you are right. So I can't use that for my case

My client specifically asking for BOM, since in our data there are special accent used.

Blue

Re: Java Mapping adding BOM to a file

Former Member — Thu, 18 Feb 2016 19:06:23 GMT

Thank you Yee.

I am using MessageTransformationBean now. Is it possible that you share your Module java code and how did you apply it in your Communication Channel.

Thanks again.

Blue

Re: Java Mapping adding BOM to a file

Ryan-Crosby — Thu, 18 Feb 2016 20:48:18 GMT

Hi Blue,

This example is very similar to your java mapping code but fits the adapter module API:


import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.rmi.RemoteException;

import javax.ejb.Stateless;
import javax.ejb.EJBException;
import javax.ejb.SessionBean;
import javax.ejb.SessionContext;


import com.sap.aii.af.lib.mp.module.Module;
import com.sap.aii.af.lib.mp.module.ModuleContext;
import com.sap.aii.af.lib.mp.module.ModuleData;
import com.sap.aii.af.lib.mp.module.ModuleException;
import com.sap.engine.interfaces.messaging.api.Message;
import com.sap.engine.interfaces.messaging.api.MessageKey;
import com.sap.engine.interfaces.messaging.api.PublicAPIAccess;
import com.sap.engine.interfaces.messaging.api.PublicAPIAccessFactory;
import com.sap.engine.interfaces.messaging.api.XMLPayload;
import com.sap.engine.interfaces.messaging.api.auditlog.AuditAccess;
import com.sap.engine.interfaces.messaging.api.auditlog.AuditLogStatus;
import com.sap.engine.interfaces.messaging.api.exception.InvalidParamException;
import com.sap.engine.interfaces.messaging.api.exception.MessagingException;

@Stateless
public class BOMBean implements SessionBean, Module{
    private static final long serialVersionUID = 1883263307825505561L;
    private MessageKey amk;
    private AuditAccess audit;
    private Message msg;

    @Override
    public ModuleData process(ModuleContext mc, ModuleData md)
            throws ModuleException {
      // Get message data and audit access
      msg = (Message) md.getPrincipalData();
      XMLPayload payload = msg.getDocument();
      amk = new MessageKey(msg.getMessageId(), msg.getMessageDirection());
      PublicAPIAccess pa;
      try {
      pa = PublicAPIAccessFactory.getPublicAPIAccess();
      } catch (MessagingException e) {
        throw new ModuleException(e.getMessage());
      }
      audit = pa.getAuditAccess();
     
      // Write BOM mark followed by full unaltered input stream
      try {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        byte[] bytes = new byte[4096];
        baos.write(0xEF);
        baos.write(0xBB);
        baos.write(0xBF);
        InputStream is = payload.getInputStream();
        while(is.read(bytes) != -1)
        {
          baos.write(bytes);
        }
        payload.setContent(baos.toByteArray());
        is.close();
        baos.close();
      } catch (IOException e) {
          audit.addAuditLogEntry(amk, AuditLogStatus.ERROR, e.getMessage());
          throw new ModuleException(e);
      } catch (InvalidParamException e) {
          audit.addAuditLogEntry(amk, AuditLogStatus.ERROR, e.getMessage());
          throw new ModuleException(e);
      }
   
      // Pass updated module data back
      return md;
    }

    @Override
    public void ejbActivate() throws EJBException, RemoteException {
    }

    @Override
    public void ejbPassivate() throws EJBException, RemoteException {
    }

    @Override
    public void ejbRemove() throws EJBException, RemoteException {
    }

    @Override
    public void setSessionContext(SessionContext arg0) throws EJBException,
            RemoteException{
    }
}

If you observe that you see multiples of 4096 bytes in the output file then the read/writing to the byte array can be adjusted to be more dynamic. I forget which streams behave that way in Java but that's easy to adjust should you find that it does not trim trailing spaces.

P.S. - this is a very basic implementation with no parameters so it's not flexible. If you wanted to make it be a bit more flexible you could look into usage of the key/value parameters to add functionality to the module.

Regards,

Ryan Crosby

Re: Java Mapping adding BOM to a file

Former Member — Fri, 19 Feb 2016 18:05:45 GMT

Thank you very much Ryan.

Do you know how to apply the BOMBean in the SFTP Receiver Channel Module tab?

Blue

Re: Java Mapping adding BOM to a file

Ryan-Crosby — Fri, 19 Feb 2016 18:12:51 GMT

Hi Blue,

Once you have the Bean deployed to your system then you would just go into the receiver channel and add it after the MessageTransformBean but before the ModuleProcessorExitBean and you don't need to add any parameters. So the sequence would be like this:

localejbs/MessageTransformBean

localejbs/BOMBean

localejbs/ModuleProcessorExitBean

Regards,

Ryan Crosby