Rename Attachment Adapter Module

[Former Member]

Image a scenario in witch the the sender system sends two files filenameHEADER.TXT
filename.ZIP
The first file is the master file, it contains header data .
The second file (filename.ZIP) will be treated as an attachment (for example in case of file to mail scenarios).
This means that in the SOAP XI Message we will see two payloads: MainDocument and the our attachment.

The File Sender Communicational Channel is configured in this way:



In this way everything works fine. In SXMB_MONI we can see that we have the payload that contains our email address, and the attachment (%F) that is our zip file.



At this point we want to change the name and the mime type of the attachment we want to give the same name of our real .ZIP file.

I’ve not found a way to do that with standard SAP modules such as PayloadSwapBean and MessageTransformationBean, so I decided to write my own module.

The RenameAttachmentModule accepts the following parameters:

- Param.AttachmentName: that is the name of the attachment that must be changed. (REQUIRED)
  Possible values:
     - any attachment name present in the XI Message.
- Param.NewAttachmentName : is the new mime type we want to assign to the attachment. (OPTIONAL)
  Possible values:
     - %f -> can be used only for file/FTP adapter, and is the File Name picked up by the communicational channel.
     - any other string.
- Param.NewAttachmentExtension is se to the extension we want to add to the new file name. (OPTIONAL)
  Possible values:
     - any string.
- Param.NewAttachmentMimeType: is the new mime type we want to assign to the attachment. (OPTIONAL)
  Possible values:
     - possible mime type.
- Param.NewAttachmentNameReplace this paramenter work in the same way of the namePart parameter in Additional file
configuration of the File Adapter.
   This parameter must be used only in case of Param.NewAttachmentName is %f and only in File Adapter. (OPTIONAL)



The result is that we now have the attachment with the desired name and mime type.




Here the code of the adapter module:

/* ***********************************************************************   * RenameAttachmentBean - Adapter Module  *  *  * Created on Mar 9, 2007  * By Bersani Francesco (francesco.bersani@techedge.it)  *   * ********************************************************************** */ package it.techedge.sap.xi.adapter.modules; import java.io.File; import java.util.Hashtable;  import javax.ejb.CreateException; import javax.ejb.SessionBean; import javax.ejb.SessionContext;  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.ra.ms.api.Payload; import com.sap.aii.af.service.auditlog.Audit; import com.sap.aii.af.service.auditlog.AuditDirection; import com.sap.aii.af.service.auditlog.AuditLogStatus; import com.sap.aii.af.service.auditlog.AuditMessageKey;  public class RenameAttachmentBean implements SessionBean, Module {      private SessionContext myContext;      public void ejbRemove()      {      }      public void ejbActivate()      {      }      public void ejbPassivate()      {      }      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;           AuditMessageKey amk = null;           ModuleException mEx = null;           Payload attachment = null;           String auditStr = "RenameAttachmentBean - ";           //initializing variables for module parameters           String modkey = "";           String attachmentName = "";           String newMimeType = "";           String newAttachmentName = "";           String newAttachmentExtension = "";           String newAttachmentNameReplace = "";           //this block is to manage the adapter when is not file/FTP           try           {                //get the XI Message                obj = inputModuleData.getPrincipalData();                msg = (Message)obj;                 // create AuditMessageKey object to write audit log.                amk = new AuditMessageKey(msg.getMessageId(), AuditDirection.OUTBOUND);                 // ******start get the module parameters from the configuration******                modkey = moduleContext.getContextData("module.key");                Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "Module Configuration Key: " + modkey);                 attachmentName = moduleContext.getContextData("Param.AttachmentName");                Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "Attachment Name: " + attachmentName);                 // check if the attachment name to modifiy has been specified                if (attachmentName == null || attachmentName.equalsIgnoreCase(""))                {                     //if no attachment name is specified in the module configuration the module will end the execution                     throw mEx = new ModuleException(auditStr + "Attachment name not specified in module configuration");                }                 newMimeType = moduleContext.getContextData("Param.NewAttachmentMimeType");                Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "New Mime Type: " + newMimeType);                 newAttachmentExtension = moduleContext.getContextData("Param.NewAttachmentExtension");                Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "New Attachment Extension: " + newAttachmentExtension);                 //this is to use only in case of %f in 'Param.NewAttachmentName'                newAttachmentNameReplace = moduleContext.getContextData("Param.NewAttachmentNameReplace");                Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "New Attachment Name Replace: " + newAttachmentNameReplace);                 //calculating newAttachmentName                newAttachmentName = moduleContext.getContextData("Param.NewAttachmentName");                if (newAttachmentName.equals("%f"))                {                     //this means that we want as attachment the same name of the file name picked up by the file adapter                     String cc_filename = "";                     Hashtable mp = (Hashtable)inputModuleData.getSupplementalData("module.parameters");                      //this gets the absolute path of the picked up file                     cc_filename = (String)mp.get("FileName");                     if (cc_filename == null || cc_filename.equalsIgnoreCase(""))                     {                          throw mEx = new ModuleException(auditStr + "You are using %f as New Attachment Name with a non file/FTP adapter");                     }                     else                     {                          //get the file name without the extension                          File a = new File(cc_filename);                          cc_filename = a.getName();                          String[] arTemp = cc_filename.split(".");                          newAttachmentName = (arTemp.length > 0) ? arTemp[0] : cc_filename;                                                    if (newAttachmentNameReplace != null && !newAttachmentNameReplace.equalsIgnoreCase(""))                          {                               // we get from the configuration the rule to get the newattachmentname from the filename.                                                        arTemp = newAttachmentNameReplace.split("=");                               arTemp[0] = arTemp[0].replaceAll(""", "");                               arTemp[1] = arTemp[1].replaceAll(""", "");                               newAttachmentName = newAttachmentName.replaceAll(arTemp[0], arTemp[1]);                          }                     }                }                Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "New Attachment Name: " + newAttachmentName);                // ******end get the module parameters from the configuration******                  //get the attachemnt from XI Message                attachment = msg.getAttachment(attachmentName);                 // ******start changing optional parameters******                 if (newAttachmentName != null && !newAttachmentName.equalsIgnoreCase(""))                {                     //check if the extension has been specified                     if (newAttachmentExtension != null && !newAttachmentExtension.equalsIgnoreCase(""))                     {                          newAttachmentName = newAttachmentName + newAttachmentExtension;                     }                      attachment.setName(newAttachmentName);                     Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "Attachment name changed to: " + newAttachmentName);                }                else                {                     Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "Attachment name not changed.");                }                 if (newMimeType != null && !newMimeType.equalsIgnoreCase(""))                {                     attachment.setContentType(newMimeType);                     Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "Mime Type changed to: " + newMimeType);                }                else                {                     Audit.addAuditLogEntry(amk, AuditLogStatus.SUCCESS, auditStr + "Mime Type not changed.");                }                // ******end changing optional parameters******                 //update the XI Message                inputModuleData.setPrincipalData(msg);           }           catch (Exception e)           {                String errorMessage = auditStr + "Error during the module execution. Exception:" + e.getMessage();                Audit.addAuditLogEntry(amk, AuditLogStatus.ERROR, errorMessage);                throw mEx = new ModuleException(auditStr + errorMessage);           }           return inputModuleData;      } }

References
How To Create Modules for the J2EE Adapter Engine
Example Adapter and Example Module