« Back to Development

Generate PDF File in Portlet

Introduction #

Liferay has a "Reports" portlet, which is a full-fledged report application. It's cool!

Sometimes a client may ask for a PDF file for simple reporting purposes. This can be a small portlet using a ResourceURL. The ResourceURL is as specified in JSR-286.

This method uses iText for generating PDF's. The AGPL that governs iText does not allow its use for closed-source projects. Use Liferay's OpenOffice/LibreOffice integration for these type projects.

Environment #

  • Liferay 5.1.2
  • Tomcat 6.0
  • MySQL

JSP Side #

<input type="button" value="Submit"
    onClick="location.href = '<portlet:resourceURL><portlet:param name="reportType" value="pdf" /></portlet:resourceURL>'" />

Portlet Java Code #

public void serveResource(ResourceRequest req, ResourceResponse res)
        throws PortletException, IOException {

        String rType = ParamUtil.getString(req, "reportType");
        
        HttpServletRequest request = PortalUtil.getHttpServletRequest(req);
        
        HttpSession session = request.getSession();
        
        ThemeDisplay themeDisplay = (ThemeDisplay)req.getAttribute(WebKeys.THEME_DISPLAY);
        
        Company company = themeDisplay.getCompany();
        
        if(rType != null && rType.equals("pdf")) {
        	
        	try {                
                    String msg = "Latest Weather Report";
                    
                    Document document = new Document();
                    
                    ByteArrayOutputStream baos = new ByteArrayOutputStream();
                    
                    PdfWriter.getInstance(document, baos);
                    
                    document.open();
                    document.add(new Paragraph(msg));
                    document.add(Chunk.NEWLINE);
                    document.add(new Paragraph("It is a sunny day today."));
                    document.close();
                    
                    res.setContentType("application/pdf");
                    res.addProperty(HttpHeaders.CACHE_CONTROL, "max-age=3600, must-revalidate");
                    
                    res.setContentLength(baos.size());
                    
                    OutputStream out = res.getPortletOutputStream();
                    baos.writeTo(out);
                    
                    out.flush();
                    out.close();
        	} catch (Exception e2) {
                    e2.System.out.println("Error in " + getClass().getName() + "\n" + e2);
        	}
        }
        else {
            try {
                Workbook wb = new HSSFWorkbook();
                
                CreationHelper createHelper = wb.getCreationHelper();
                
                Sheet sheet = wb.createSheet("new sheet");

                Row row = sheet.createRow((short)0);
                Cell cell = row.createCell(0);
                cell.setCellValue(1);

                row.createCell(1).setCellValue(1.2);
                row.createCell(2).setCellValue(
                createHelper.createRichTextString("This is a string"));
                row.createCell(3).setCellValue(true);

                res.setContentType("application/vnd.ms-excel");
                res.addProperty(
                HttpHeaders.CACHE_CONTROL, "max-age=3600, must-revalidate");

                OutputStream out = res.getPortletOutputStream();
                wb.write(out);
                out.flush();
                out.close();
            } catch (Exception e) {
                System.out.println("Exception occurred ...");
            }
        }
}

Future Enhancement #

(1) Generate an Excel report

0 Attachments
41263 Views
Average (3 Votes)
The average rating is 4.33333333333333 stars out of 5.
Comments
Threaded Replies Author Date
Hi I just want to know what jar files I need... Mohammed Azam November 5, 2012 5:00 AM
The PDF generation seems to use iText PDF... Adam Victor Nazareth Brandizzi November 5, 2012 5:01 AM
good morning, I would ask how I can save the pdf? josmar javier Alarcon Bothia February 11, 2013 6:08 AM
Thanks for Sharing.it is working. we need to... Ravi Teja March 21, 2013 5:02 AM
Please follow this link to get sample portlet... Ravi Teja March 22, 2013 5:13 AM
Ravi Teja your link is not working djo vitch June 6, 2013 3:25 AM
Hi Vitch, Please go to below link. and there... Ravi Teja October 1, 2013 10:51 PM
How to display the values in table instead of... Kalai arasan September 30, 2013 5:16 AM
Hi Kalai arasan, Please go throw this link... Ravi Teja October 1, 2013 10:47 PM
I wants to know the jar files needs to be... Kalai arasan November 19, 2013 10:30 PM
PDF generation is working fine. Bur i wants to... Kalai arasan November 19, 2013 10:32 PM
I wants to know either i create the class for... Kalai arasan November 19, 2013 10:35 PM
Hi! i used the code to generate pdf that works... Kalai arasan December 1, 2013 11:38 PM
We can refresh portlet after download file?... Roman Pelegin February 17, 2014 4:27 AM
hi How can i extract lpkg file to see war file veeresh hosamani April 11, 2014 1:46 AM

Hi

I just want to know what jar files I need to import packages.
Posted on 11/5/12 5:00 AM.
The PDF generation seems to use iText PDF (http://itextpdf.com/) and the other report seems to be generated by Apache POI (http://poi.apache.org/).
Posted on 11/5/12 5:01 AM in reply to Mohammed Azam.
good morning, I would ask how I can save the pdf?
Posted on 2/11/13 6:08 AM.
Thanks for Sharing.it is working.
we need to add i text jar in lib.
Posted on 3/21/13 5:02 AM in reply to josmar javier Alarcon Bothia.
Please follow this link to get sample portlet
.it will open in popwindow as well as ask for download.
(http://www.liferay.com/community/forums/-/message_boards/message/22909­051)
Posted on 3/22/13 5:13 AM in reply to Ravi Teja.
Ravi Teja your link is not working
Posted on 6/6/13 3:25 AM in reply to Ravi Teja.
How to display the values in table instead of paragraph in pdf?
Posted on 9/30/13 5:16 AM.
Hi Kalai arasan,

Please go throw this link (http://tutorials.jenkov.com/java-itext/table.html).
Posted on 10/1/13 10:47 PM in reply to Kalai arasan.
Hi Vitch,

Please go to below link. and there you can find ( pdfgeneration-portlet.rar )
https://www.liferay.com/community/forums/-/message_boards/message/22903036
Posted on 10/1/13 10:51 PM in reply to djo vitch.
I wants to know the jar files needs to be included!
Posted on 11/19/13 10:30 PM.
PDF generation is working fine. Bur i wants to generate excel sheet that's the problem arise with import files because of missing jar files.
Posted on 11/19/13 10:32 PM.
I wants to know either i create the class for Workbook wb = new HSSFWorkbook(); or import file for Workbook and HSSFWorkbook.
Posted on 11/19/13 10:35 PM in reply to Kalai arasan.
Hi! i used the code to generate pdf that works fine, But both pdf and excel will appears in the name of the site page automatically. How can i give the name for documents manually.
Posted on 12/1/13 11:38 PM.
We can refresh portlet after download file? File downloaded successfully, but submit button after this look like pressed. Thanks.
Posted on 2/17/14 4:27 AM.
hi
How can i extract lpkg file to see war file
Posted on 4/11/14 1:46 AM.