One of my customers wanted an easy way for printing XPages in different formats and with different content, depending of the current XPage opened in the browser. It was a requirement to develope a global solution for every XPage-based application in his company. That is why I created a global Java class which does not require to modify the existing applications at all. But it allows to customize and configure the output for the different needs of the departments and their required reports and print outs.<\/p>\n
I decided to use a special PhaseListener<\/em> to hook into the different applications. This allows the PDF generation depending on some URL parameters, and only runs if the URI contains a special command for printing the current XPage (but works for thw whole application).<\/p>\n The example code is what I have created:<\/p>\n The PhaseListener<\/em> scans the URI every time a request is sent to the server. As soon the URI ends with .PDF<\/em>, the parameters fileNam<\/em>e and type<\/em> are extracted. The correct PDF template is identified and the requested PDF can be generated (Code for generating is not included in this example).<\/p>\n After generating the PDF, the output is written, and the response is completed. The file download headers are added to the response. The user receives a file download dialog and can open the generated PDF (and print it if required).<\/p>\n When this PhaseListener<\/em> is enabled in the faces-config.xml<\/em>, every XPage can use the URL command. For example if your XPage is named „MyXPage.xsp“ the URL to enable the PDF generation instead the generation of the XPage looks like this:<\/p>\n This returns a PDF with the filename test.pdf<\/em> which is generated from the PDF template exportAll,<\/em> containing the data of the current XPage. It is easy to add a link like this to your application to enable the PDF generation.<\/p>\n This is how the faces-config.xml<\/em> has to look like:<\/p>\n One of my customers wanted an easy way for printing XPages in different formats and with different content, depending of the current XPage opened in the browser. It was a requirement to develope a global solution for every XPage-based application … Weiterlesen package ch.hasselba.xpages.util;\r\n\r\nimport java.util.Map;\r\nimport javax.faces.context.FacesContext;\r\nimport javax.faces.event.PhaseEvent;\r\nimport javax.faces.event.PhaseId;\r\nimport javax.faces.event.PhaseListener;\r\nimport javax.servlet.ServletOutputStream;\r\nimport javax.servlet.http.HttpServletRequest;\r\nimport javax.servlet.http.HttpServletResponse;\r\n\r\npublic class PhaseListenerPDFGenerator implements PhaseListener {\r\n\r\n\u00a0\u00a0 \u00a0private static final long serialVersionUID = 1L;\r\n\u00a0\u00a0 \u00a0private static final String GENERATE_PDF = \".PDF\";\r\n\u00a0\u00a0 \u00a0private static final String URL_PARAMETER_FILENAME = \"filename\";\r\n\u00a0\u00a0 \u00a0private static final String URL_PARAMETER_PDFTYPE = \"type\";\r\n\u00a0\u00a0 \u00a0private static final String HTTP_HEADER_CONTENTTYPE = \"application\/pdf\";\r\n\r\n\u00a0\u00a0 \u00a0public void beforePhase(PhaseEvent event) {}\r\n\r\n\u00a0\u00a0 \u00a0public PhaseId getPhaseId() {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0return PhaseId.RESTORE_VIEW;\r\n\u00a0\u00a0 \u00a0}\r\n\r\n\u00a0\u00a0 \u00a0public void afterPhase(PhaseEvent event) {\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0FacesContext facesContext = event.getFacesContext();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0HttpServletRequest req = (HttpServletRequest) facesContext\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0.getExternalContext().getRequest();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String uri = req.getRequestURI();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0if (uri.endsWith(GENERATE_PDF) == true ) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0servePDF(facesContext);\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0}\r\n\r\n\u00a0\u00a0 \u00a0private void servePDF(FacesContext facesContext) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0Map requestMap = facesContext.getExternalContext()\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0.getRequestParameterMap();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String pdfName = getPDFName(requestMap);\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String pdfType = getPDFType(requestMap);\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0HttpServletResponse response = (HttpServletResponse) facesContext\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0.getExternalContext().getResponse();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0try {\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0response.setContentType( HTTP_HEADER_CONTENTTYPE );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0response.setHeader( \"Content-Disposition\", \"attachment; filename=\"\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0 + pdfName );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0response.setStatus(200);\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0ServletOutputStream outputStream = response.getOutputStream();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ Generate the PDF here\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ and send the data to the outputStream\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/outputStream.write( PDFDATA );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0outputStream.flush();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0outputStream.close();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0facesContext.responseComplete();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0} catch (Exception exception) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0exception.printStackTrace();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0}\r\n\r\n\u00a0\u00a0 \u00a0public static String getPDFName(Map requestMap) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String pdfName = (String) requestMap.get( URL_PARAMETER_FILENAME );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0return pdfName;\r\n\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0public static String getPDFType(Map requestMap) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String pdfName = (String) requestMap.get( URL_PARAMETER_PDFTYPE );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0return pdfName;\r\n\u00a0\u00a0 \u00a0}\r\n\r\n}\r\n<\/code><\/pre>\nhttp:\/\/example.com\/path\/to\/db.nsf\/MyXPage.xsp\/.PDF?filename=test.pdf&type=exportAll<\/pre>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<faces-config>\r\n\u00a0 <lifecycle>\r\n\u00a0 \u00a0\u00a0 \u00a0<phase-listener>ch.hasselba.xpages.util.PhaseListenerPDFGenerator<\/phase-listener>\r\n\u00a0 <\/lifecycle>\r\n<\/faces-config><\/pre>\n","protected":false},"excerpt":{"rendered":"