Class FopPrintServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.fop.servlet.FopServlet

org.apache.fop.servlet.FopPrintServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class FopPrintServlet
extends FopServlet

Example servlet to generate a fop printout from a servlet. Printing goes to the default printer on host where the servlet executes. Servlet param is:

• fo: the path to a XSL-FO file to render

or

• xml: the path to an XML file to render
• xslt: the path to an XSLT file that can transform the above XML to XSL-FO

Example URL: http://servername/fop/servlet/FopPrintServlet?fo=readme.fo
Example URL: http://servername/fop/servlet/FopPrintServlet?xml=data.xml
Note: This servlet is derived from FopServlet. Most methods are inherited from the superclass. Only the differences to the base class are necessary.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID

Fields inherited from class FopServlet

FO_REQUEST_PARAM, fopFactory, transFactory, uriResolver, XML_REQUEST_PARAM, XSLT_REQUEST_PARAM

Constructor Summary

Constructors

Constructor	Description
FopPrintServlet()

Method Summary

Modifier and Type	Method	Description
protected void	render(Source src, Transformer transformer, jakarta.servlet.http.HttpServletResponse response)	Renders an input file (XML or XSL-FO) into a PDF file.
private void	reportOK(jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class FopServlet

configureFopFactory, convertString2Source, doGet, getFOUserAgent, init, renderFO, renderXML

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

FopPrintServlet

public FopPrintServlet()

Method Details

render

protected void render(Source src,
 Transformer transformer,
 jakarta.servlet.http.HttpServletResponse response)
               throws FOPException,
TransformerException,
IOException

Renders an input file (XML or XSL-FO) into a PDF file. It uses the JAXP transformer given to optionally transform the input document to XSL-FO. The transformer may be an identity transformer in which case the input must already be XSL-FO. The PDF is written to a byte array that is returned as the method's result.

Overrides:

render in class FopServlet

Parameters:

src - Input XML or XSL-FO

transformer - Transformer to use for optional transformation

response - HTTP response object

Throws:

FOPException - If an error occurs during the rendering of the XSL-FO

TransformerException - If an error occurs during XSL transformation

IOException - In case of an I/O problem

reportOK

private void reportOK(jakarta.servlet.http.HttpServletResponse response)
               throws IOException

Throws:

IOException