{"id":1045,"date":"2012-11-15T23:10:23","date_gmt":"2012-11-15T21:10:23","guid":{"rendered":"http:\/\/hasselba.ch\/blog\/?p=1045"},"modified":"2012-11-16T10:55:52","modified_gmt":"2012-11-16T08:55:52","slug":"xpinc-and-attachments-a-better-pdf-handling","status":"publish","type":"post","link":"https:\/\/hasselba.ch\/blog\/?p=1045","title":{"rendered":"XPiNC and Attachments: A better PDF handling"},"content":{"rendered":"

For one of my customers I have created a small XPiNC application with contains a lot of documents with attached PDFs. One of the key requirements was the posibility to open and read a PDF directly in Notes Client, without storing it on the desktop.<\/p>\n

The first thing to know is that XPiNC applications are running in XULRunner<\/a>, which means that there is a compatibility to Firefox. That’s why you can use FF plugins*, for example the Foxit Reader plugin (npFoxitReaderPlugin.dll<\/em>) or the original Acrobat Reader plugin.<\/p>\n

These plugins have to be copied to the XULRunner folder, f.e.<\/p>\n

C:\\Lotus\\Notes\\framework\\rcp\\eclipse\\plugins\\com.ibm.rcp.xulrunner.runtime.win32.x86_6.2.3.20110915-1350\\xulrunner\\plugins<\/pre>\n
The plugin has to be installed\/copied to each Notes client. For my customer this was no problem and could be done manually because only a small group of users will use the application.<\/p>\n
In a second step I have created a XPage which creates the output of the attached PDF:<\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<xp:view xmlns:xp=\"http:\/\/www.ibm.com\/xsp\/core\" rendered=\"false\">\r\n\r\n   <xp:this.data>\r\n      <xp:dominoDocument var=\"documentAttachment\" action=\"openDocument\" \/>\r\n   <\/xp:this.data>\r\n\r\n   <xp:this.afterRenderResponse>\r\n      <![CDATA[#{javascript:\r\n         importPackage( ch.hasselba.xpages.xpinc );\r\n         var exCon = facesContext.getExternalContext();\r\n         var response = exCon.getResponse().getDelegate();\r\n\r\n         AttachmentHelper.sendFile( response, session,\r\n            documentAttachment.getDocument(), param.get(\"attachment\") );\r\n      }]]>\r\n   <\/xp:this.afterRenderResponse>\r\n<\/xp:view><\/pre>\n
As you can see the main trick is to use the delegated response<\/a> instead of the default XPages response object<\/del>. And here comes the Java backend class, the attachment handler:<\/p>\n
package ch.hasselba.xpages.xpinc;\r\n\r\nimport javax.servlet.ServletOutputStream;\r\nimport javax.servlet.http.HttpServletResponse;\r\nimport com.ibm.designer.runtime.util.MIME;\r\nimport lotus.domino.Document;\r\nimport lotus.domino.MIMEEntity;\r\nimport lotus.domino.MIMEHeader;\r\nimport lotus.domino.NotesException;\r\nimport lotus.domino.Session;\r\nimport lotus.domino.Stream;\r\nimport java.io.IOException;\r\n\r\npublic class AttachmentHelper {\r\n\r\n   private final static String MIMEHEADER_CONTENTDISPOSITION = \"Content-Disposition\";\r\n   private final static String MIMEHEADERVAL_ATTACHMENT = \"attachment\";\r\n   private final static String MIMEHEADERPARAM_FILENAME = \"filename\";\r\n   private final static String SPLIT_CHAR = \"\\\"\";\r\n\r\n   public static void sendFile(final HttpServletResponse response,\r\n      Session session, Document doc, final String attachmentName) {\r\n\r\n      ServletOutputStream out = null;\r\n      MIMEEntity mime = null;\r\n      MIMEHeader mimeHeader = null;\r\n      boolean flagConvertToMime;\r\n      try {\r\n         \/\/ get the output stream\r\n         out = response.getOutputStream();\r\n\r\n         \/\/ store MIME convert settings\r\n         flagConvertToMime = session.isConvertMime();\r\n\r\n         \/\/ switch MIME convert mode\r\n         session.setConvertMIME(false);\r\n\r\n         \/\/ convert Doc to MIME\r\n         doc.convertToMIME();\r\n\r\n         \/\/ process document as MIME\r\n         mime = doc.getMIMEEntity();\r\n\r\n         while (mime != null) {\r\n            mimeHeader = mime.getNthHeader(MIMEHEADER_CONTENTDISPOSITION);\r\n            if (mimeHeader != null) {\r\n               if (MIMEHEADERVAL_ATTACHMENT.equals(mimeHeader\r\n                  .getHeaderVal(true))) {\r\n\r\n               \/\/ extract filename\r\n               String fileName = mimeHeader.getParamVal(MIMEHEADERPARAM_FILENAME);\r\n\r\n               \/\/ remove double slashes\r\n               fileName = fileName.split(SPLIT_CHAR)[1];\r\n\r\n               \/\/ set content type\r\n               response.setContentType(MIME\r\n                  .getMIMETypeFromExtension(MIME\r\n                     .getFileExtension(fileName)));\r\n\r\n               \/\/ check if this is the requested attachment\r\n               if (attachmentName.equals(fileName)) {\r\n\r\n                  \/\/ get MIME data as stream and send to output\r\n                  Stream stream = session.createStream();\r\n                  mime.getContentAsBytes(stream);\r\n                  stream.getContents(out);\r\n                  stream.close();\r\n               }\r\n            }\r\n         }\r\n\r\n         \/\/ next MIME entity\r\n         mime = mime.getNextEntity(MIMEEntity.SEARCH_DEPTH);\r\n      }\r\n\r\n      \/\/ revert MIME conversion\r\n      session.setConvertMIME(flagConvertToMime);\r\n\r\n      } catch (IOException e) {\r\n         e.printStackTrace();\r\n      } catch (NotesException e) {\r\n         e.printStackTrace();\r\n      } finally {\r\n        recycleObject(mimeHeader);\r\n        recycleObject(mime);\r\n      }\r\n   }\r\n   \/**\r\n   * recycles a domino document instance\r\n   *\r\n   * @param lotus\r\n   *\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .domino.Base obj to recycle\r\n   * @category Domino\r\n   * @author Sven Hasselbach\r\n   * @category Tools\r\n   * @version 1.1\r\n   *\/\r\n   public static void recycleObject(lotus.domino.Base obj) {\r\n      if (obj != null) {\r\n         try {\r\n            obj.recycle();\r\n         } catch (Exception e) {}\r\n      }\r\n   }\r\n}<\/pre>\n
The document can contain more than one attachment at once. Now you can create links to this XPage in the format <\/em><\/p>\n
PDF.xsp?documentId=<DOCUNID>&attachment=<NAME_OF_ATTACHMENT><\/em><\/pre>\n
\"\"<\/p>\n
If you are clicking the link, the PDF will be displayed in the Notes Client:<\/p>\n
\"\"<\/p>\n
*: there is no gurantee that other plugins are working correctly!<\/p>\n","protected":false},"excerpt":{"rendered":"
For one of my customers I have created a small XPiNC application with contains a lot of documents with attached PDFs. One of the key requirements was the posibility to open and read a PDF directly in Notes Client, without … Weiterlesen →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,18,89,76,74,44],"tags":[33,7,5,32,3,95],"class_list":["post-1045","post","type-post","status-publish","format-standard","hentry","category-allgemein","category-infrastruktur","category-java","category-ssjs","category-xpages","category-xpinc","tag-8-5-3","tag-domino","tag-ssjs","tag-tipp","tag-xpages","tag-xpinc"],"_links":{"self":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1045","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1045"}],"version-history":[{"count":11,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1045\/revisions"}],"predecessor-version":[{"id":1056,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1045\/revisions\/1056"}],"wp:attachment":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1045"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1045"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1045"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}