123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255 |
- /*
- * $Id: FopServlet.java,v 1.2 2003/03/07 09:48:05 jeremias Exp $
- * ============================================================================
- * The Apache Software License, Version 1.1
- * ============================================================================
- *
- * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modifica-
- * tion, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * 3. The end-user documentation included with the redistribution, if any, must
- * include the following acknowledgment: "This product includes software
- * developed by the Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself, if
- * and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "FOP" and "Apache Software Foundation" must not be used to
- * endorse or promote products derived from this software without prior
- * written permission. For written permission, please contact
- * apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache", nor may
- * "Apache" appear in their name, without prior written permission of the
- * Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
- * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
- * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * ============================================================================
- *
- * This software consists of voluntary contributions made by many individuals
- * on behalf of the Apache Software Foundation and was originally created by
- * James Tauber <jtauber@jtauber.com>. For more information on the Apache
- * Software Foundation, please see <http://www.apache.org/>.
- */
- package org.apache.fop.servlet;
-
- import java.io.ByteArrayOutputStream;
- import java.io.File;
- import java.io.PrintWriter;
-
- import javax.servlet.ServletException;
- import javax.servlet.http.HttpServlet;
- import javax.servlet.http.HttpServletRequest;
- import javax.servlet.http.HttpServletResponse;
- import javax.xml.transform.Result;
- import javax.xml.transform.Source;
- import javax.xml.transform.Transformer;
- import javax.xml.transform.TransformerException;
- import javax.xml.transform.TransformerFactory;
- import javax.xml.transform.sax.SAXResult;
- import javax.xml.transform.stream.StreamSource;
-
- // Avalon
- import org.apache.avalon.framework.logger.ConsoleLogger;
- import org.apache.avalon.framework.logger.Logger;
-
- //FOP
- import org.apache.fop.apps.Session;
- import org.apache.fop.apps.FOPException;
-
- /**
- * Example servlet to generate a PDF from a servlet.
- * <br/>
- * Servlet param is:
- * <ul>
- * <li>fo: the path to a XSL-FO file to render
- * </ul>
- * or
- * <ul>
- * <li>xml: the path to an XML file to render</li>
- * <li>xslt: the path to an XSLT file that can transform the above XML to XSL-FO</li>
- * </ul>
- * <br/>
- * Example URL: http://servername/fop/servlet/FopServlet?fo=readme.fo
- * <br/>
- * Example URL: http://servername/fop/servlet/FopServlet?xml=data.xml&xslt=format.xsl
- * <br/>
- * For this to work with Internet Explorer, you might need to append "&ext=.pdf"
- * to the URL.
- *
- * @author <a href="mailto:fop-dev@xml.apache.org">Apache XML FOP Development Team</a>
- * @version $Id: FopServlet.java,v 1.2 2003/03/07 09:48:05 jeremias Exp $
- * (todo) Ev. add caching mechanism for Templates objects
- */
- public class FopServlet extends HttpServlet {
-
- /** Name of the parameter used for the XSL-FO file */
- protected static final String FO_REQUEST_PARAM = "fo";
- /** Name of the parameter used for the XML file */
- protected static final String XML_REQUEST_PARAM = "xml";
- /** Name of the parameter used for the XSLT file */
- protected static final String XSLT_REQUEST_PARAM = "xslt";
-
- /** Logger to give to FOP */
- protected Logger log = null;
- /** The TransformerFactory to use to create Transformer instances */
- protected TransformerFactory transFactory = null;
-
- /**
- * @see javax.servlet.GenericServlet#init()
- */
- public void init() throws ServletException {
- this.log = new ConsoleLogger(ConsoleLogger.LEVEL_WARN);
- this.transFactory = TransformerFactory.newInstance();
- }
-
- /**
- * @see javax.servlet.http.HttpServlet#doGet(HttpServletRequest, HttpServletResponse)
- */
- public void doGet(HttpServletRequest request,
- HttpServletResponse response) throws ServletException {
- try {
- //Get parameters
- String foParam = request.getParameter(FO_REQUEST_PARAM);
- String xmlParam = request.getParameter(XML_REQUEST_PARAM);
- String xsltParam = request.getParameter(XSLT_REQUEST_PARAM);
-
- //Analyze parameters and decide with method to use
- byte[] content = null;
- if (foParam != null) {
- content = renderFO(foParam);
- } else if ((xmlParam != null) && (xsltParam != null)) {
- content = renderXML(xmlParam, xsltParam);
- } else {
- PrintWriter out = response.getWriter();
- out.println("<html><head><title>Error</title></head>\n"
- + "<body><h1>FopServlet Error</h1><h3>No 'fo' "
- + "request param given.</body></html>");
- }
-
- if (content != null) {
- //Send the result back to the client
- response.setContentType("application/pdf");
- response.setContentLength(content.length);
- response.getOutputStream().write(content);
- response.getOutputStream().flush();
- }
-
- } catch (Exception ex) {
- throw new ServletException(ex);
- }
- }
-
- /**
- * Converts a String parameter to a JAXP Source object.
- * @param param a String parameter
- * @return Source the generated Source object
- */
- protected Source convertString2Source(String param) {
- return new StreamSource(new File(param));
- }
-
- /**
- * Renders an XSL-FO file into a PDF file. The PDF is written to a byte
- * array that is returned as the method's result.
- * @param fo the XSL-FO file
- * @return byte[] the rendered PDF file
- * @throws FOPException If an error occurs during the rendering of the
- * XSL-FO
- * @throws TransformerException If an error occurs while parsing the input
- * file
- */
- protected byte[] renderFO(String fo)
- throws FOPException, TransformerException {
-
- //Setup source
- Source foSrc = convertString2Source(fo);
-
- //Setup the identity transformation
- Transformer transformer = this.transFactory.newTransformer();
-
- //Start transformation and rendering process
- return render(foSrc, transformer);
- }
-
- /**
- * Renders an XML file into a PDF file by applying a stylesheet
- * that converts the XML to XSL-FO. The PDF is written to a byte array
- * that is returned as the method's result.
- * @param xml the XML file
- * @param xslt the XSLT file
- * @return byte[] the rendered PDF file
- * @throws FOPException If an error occurs during the rendering of the
- * XSL-FO
- * @throws TransformerException If an error occurs during XSL
- * transformation
- */
- protected byte[] renderXML(String xml, String xslt)
- throws FOPException, TransformerException {
-
- //Setup sources
- Source xmlSrc = convertString2Source(xml);
- Source xsltSrc = convertString2Source(xslt);
-
- //Setup the XSL transformation
- Transformer transformer = this.transFactory.newTransformer(xsltSrc);
-
- //Start transformation and rendering process
- return render(xmlSrc, transformer);
- }
-
- /**
- * 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.
- * @param src Input XML or XSL-FO
- * @param transformer Transformer to use for optional transformation
- * @return byte[] the rendered PDF file
- * @throws FOPException If an error occurs during the rendering of the
- * XSL-FO
- * @throws TransformerException If an error occurs during XSL
- * transformation
- */
- protected byte[] render(Source src, Transformer transformer)
- throws FOPException, TransformerException {
-
- //Setup FOP
- Session session = new Session();
- session.enableLogging(this.log);
- session.setRenderer(Session.RENDER_PDF);
- session.initialize();
-
- //Setup output
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- session.setOutputStream(out);
-
- //Make sure the XSL transformation's result is piped through to FOP
- Result res = new SAXResult(session.getContentHandler());
-
- //Start the transformation and rendering process
- transformer.transform(src, res);
-
- //Return the result
- return out.toByteArray();
- }
-
- }
|