FopPrintServlet (Apache FOP 2.1 API)

Skip navigation links

fop 2.1

Prev Class
Next Class

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.apache.fop.servlet.FopServlet
    - - org.apache.fop.servlet.FopPrintServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
```
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&xsl=format.xsl
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 inherited from class org.apache.fop.servlet.FopServlet
  FO_REQUEST_PARAM, fopFactory, transFactory, uriResolver, XML_REQUEST_PARAM, XSLT_REQUEST_PARAM

Constructor Summary

Constructors
Constructor Description

FopPrintServlet()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`render(javax.xml.transform.Source src, javax.xml.transform.Transformer transformer, javax.servlet.http.HttpServletResponse response)`	Renders an input file (XML or XSL-FO) into a PDF file.

Methods inherited from class org.apache.fop.servlet.FopServlet
configureFopFactory, convertString2Source, doGet, getFOUserAgent, init, renderFO, renderXML

Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FopPrintServlet
```
public FopPrintServlet()
```
- Method Detail
  - render
```
protected void render(javax.xml.transform.Source src,
                      javax.xml.transform.Transformer transformer,
                      javax.servlet.http.HttpServletResponse response)
               throws FOPException,
                      javax.xml.transform.TransformerException,
                      java.io.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
    
    javax.xml.transform.TransformerException - If an error occurs during XSL transformation
    
    java.io.IOException - In case of an I/O problem

Skip navigation links

fop 2.1

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright 1999-2016 The Apache Software Foundation. All Rights Reserved.