Class JakartaPDFFilter

  • All Implemented Interfaces:
    Filter, org.xml.sax.ErrorHandler

    public class JakartaPDFFilter
    extends java.lang.Object
    implements Filter, org.xml.sax.ErrorHandler

    The JakartaPDFFilter class is an implementation of the Servlet 6 Filter interface, which automatically converts an XML report into a PDF which is returned to the client. It is identical to PDFFilter except based on the jakarta.servlet package instead of javax.servlet.

    More information on installing filters is available in the Servlet Specification and has probably been supplied with your Servlet engine. For the impatient, here's an example setup which would cause all requests to anything in the /pdf/ path of your website to be converted to a PDF. Add the following lines to your WEB-INF/web.xml file:


    Meta tags that aren't already known to the Report Generator and that begin with "HTTP-" are added to the response header (minus the "HTTP-" prefix). An example would be to place <meta name="HTTP-Expires" value="Mon, 01 Jan 1999 12:00:00 GMT"> in the head of the XML, which would set the "Expires" header in the HTTP response.

    The following custom Meta-Tags may also be used to control the behaviour of the servlet.

    • Servlet-Filename - ask the client browser to save the file as the specified filename instead of displaying it inline. This uses the Content-Disposition header, which in theory is accepted by NS4+ and IE5+, although this known bug in IE5.5 may prevent the document from being viewed at all. Use with caution unless you know your audiences browsers.
    Some initialization parameters can be set in the web.xml file to further control various internal aspects of the servlet:
    • org.xml.sax.driver - may be set to the base class of your SAX parsers XMLReader implementation, if the generator is unable to locate it.
    • - may be set to true or false to generate warnings about unknown tags. Default is "true"
    • - may be set to true or false to generate warnings about unknown attributes. Default is "true"
    • - may be set to true or false to generate warnings about misplaced text. Default is "true"
    • cache-minsize and cache-prefix - can be set to cache parts of the created document to disk.

    These last two parameters were added in version 1.1.19 to cause parts of the document to be cached to disk. This can reduce memory footprint slightly, although it may slow things down a little so you must decide whether it's appropriate or not. The cache-prefix and cache-minsize parameters are passed into the DiskCache constructor - essentially the prefix should be a temporary directory, optionally with the first half of a filename. The minsize parameter sets the minimum size a stream may be before it's considered to be worth caching to disk. For example, to store streams greater than 8k in the "/tmp/cache" directory and call them "bfo.1", "bfo.2" and so on, you could do something like this:


    This class also implements org.xml.sax.ErrorHandler, to deal with any errors found during the XML parsing process. Currently all warnings and errors are fatal, and logged to System.err. To change this behaviour, subclass this class and override the warning, error and fatalError methods.

    • Constructor Detail

      • JakartaPDFFilter

        public JakartaPDFFilter()
    • Method Detail

      • destroy

        public void destroy()
        Specified by:
        destroy in interface Filter
      • getFilterConfig

        public FilterConfig getFilterConfig()
        Return the Filter Config. A non-standard method required for WebLogic 6.1
      • setFilterConfig

        public void setFilterConfig​(FilterConfig conf)
        Set the Filter Config. A non-standard method required for WebLogic 6.1
      • modifyPDF

        protected void modifyPDF​(PDF pdf)
        If you need to modify the PDF in any way after it has been generated, you can do it by extending the PDFFilter class and overriding this method. By default this method is a no-op.
      • metaTag

        public void metaTag​(HttpServletRequest reader,
                            HttpServletResponse writer,
                            java.lang.String name,
                            java.lang.String value)
                     throws ServletException,
        Handle any meta tags that aren't recognised by the core Report Generator. This method recognises tags begining with HTTP-, as well as Servlet-FileName.
        request - the Servlet request
        response - the Servlet request
        name - the "name" attribute from the meta tag
        value - the "value" attribute from the meta tag
      • warning

        public void warning​(org.xml.sax.SAXParseException exception)
                     throws org.xml.sax.SAXException
        Specified by:
        warning in interface org.xml.sax.ErrorHandler
      • error

        public void error​(org.xml.sax.SAXParseException exception)
                   throws org.xml.sax.SAXException
        Specified by:
        error in interface org.xml.sax.ErrorHandler
      • fatalError

        public void fatalError​(org.xml.sax.SAXParseException exception)
                        throws org.xml.sax.SAXException
        Specified by:
        fatalError in interface org.xml.sax.ErrorHandler