Top Description Constructors Methods
org.springframework.web.servlet.view.document

public abstract Class AbstractPdfStamperView

extends AbstractUrlBasedView
Class Inheritance
Imports
java.io.ByteArrayOutputStream, .IOException, java.util.Map, com.lowagie.text.pdf.PdfReader, com.lowagie.text.pdf.PdfStamper, jakarta.servlet.http.HttpServletRequest, .HttpServletResponse, org.springframework.util.Assert, org.springframework.web.servlet.view.AbstractUrlBasedView
Abstract superclass for PDF views that operate on an existing document with an AcroForm. Application-specific view classes will extend this class to merge the PDF form with model data.

This view implementation uses Bruno Lowagie's iText API. Known to work with the original iText 2.1.7 as well as its fork OpenPDF. We strongly recommend OpenPDF since it is actively maintained and fixes an important vulnerability for untrusted PDF content.

Thanks to Bryant Larsen for the suggestion and the original prototype!

Author
Juergen Hoeller
Since
2.5.4
See Also
AbstractPdfView

Constructor Summary

AccessConstructor and Description
public
AbstractPdfStamperView()

Method Summary

Modifier and TypeMethod and Description
protected boolean
generatesDownloadContent()

Overrides org.springframework.web.servlet.view.AbstractView.generatesDownloadContent.

Return whether this view generates download content (typically binary content like PDF or Excel files).

protected abstract void
mergePdfDocument(Map<String, Object>
the model Map
model, com.lowagie.text.pdf.PdfStamper
the PdfStamper instance that will contain the AcroFields. You may also customize this PdfStamper instance according to your needs, e.g. setting the "formFlattening" property.
stamper, HttpServletRequest
in case we need locale etc. Shouldn't look at attributes.
request, HttpServletResponse
in case we need to set cookies. Shouldn't write to it.
response)

Subclasses must implement this method to merge the PDF form with the given model data.

protected com.lowagie.text.pdf.PdfReader

Returns:

the PdfReader instance
readPdfResource()

Read the raw PDF resource into an iText PdfReader.

protected final void
renderMergedOutputModel(Map<String, Object>
combined output Map (never null), with dynamic values taking precedence over static attributes
model, HttpServletRequest
current HTTP request
request, HttpServletResponse
current HTTP response
response)

Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

Subclasses must implement this method to actually render the view.

Inherited from org.springframework.web.servlet.view.AbstractUrlBasedView:
afterPropertiesSetcheckResourcegetUrlisUrlRequiredsetUrltoString

Constructor Detail

AbstractPdfStamperViewback to summary
public AbstractPdfStamperView()

Method Detail

generatesDownloadContentback to summary
protected boolean generatesDownloadContent()

Overrides org.springframework.web.servlet.view.AbstractView.generatesDownloadContent.

Doc from org.springframework.web.servlet.view.AbstractView.generatesDownloadContent.

Return whether this view generates download content (typically binary content like PDF or Excel files).

The default implementation returns false. Subclasses are encouraged to return true here if they know that they are generating download content that requires temporary caching on the client side, typically via the response OutputStream.

Annotations
@Override
mergePdfDocumentback to summary
protected abstract void mergePdfDocument(Map<String, Object> model, com.lowagie.text.pdf.PdfStamper stamper, HttpServletRequest request, HttpServletResponse response) throws Exception

Subclasses must implement this method to merge the PDF form with the given model data.

This is where you are able to set values on the AcroForm. An example of what can be done at this level is: 

// get the form from the document
AcroFields form = stamper.getAcroFields();

// set some values on the form
form.setField("field1", "value1");
form.setField("field2", "value2");

// set the disposition and filename
response.setHeader("Content-disposition", "attachment; FILENAME=someName.pdf");

Note that the passed-in HTTP response is just supposed to be used for setting cookies or other HTTP headers. The built PDF document itself will automatically get written to the response after this method returns.

Parameters
model:Map<String, Object>

the model Map

stamper:com.lowagie.text.pdf.PdfStamper

the PdfStamper instance that will contain the AcroFields. You may also customize this PdfStamper instance according to your needs, e.g. setting the "formFlattening" property.

request:HttpServletRequest

in case we need locale etc. Shouldn't look at attributes.

response:HttpServletResponse

in case we need to set cookies. Shouldn't write to it.

Exceptions
Exception:
any exception that occurred during document building
readPdfResourceback to summary
protected com.lowagie.text.pdf.PdfReader readPdfResource() throws IOException

Read the raw PDF resource into an iText PdfReader.

The default implementation resolve the specified "url" property as ApplicationContext resource.

Returns:com.lowagie.text.pdf.PdfReader

the PdfReader instance

Exceptions
IOException:
if resource access failed
See Also
setUrl
renderMergedOutputModelback to summary
protected final void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception

Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

Subclasses must implement this method to actually render the view.

The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.

Parameters
model:Map<String, Object>

combined output Map (never null), with dynamic values taking precedence over static attributes

request:HttpServletRequest

current HTTP request

response:HttpServletResponse

current HTTP response

Annotations
@Override
Exceptions
Exception:
if rendering failed