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

public abstract Class AbstractPdfView

extends AbstractView
Class Inheritance
Imports
java.io.ByteArrayOutputStream, .OutputStream, java.util.Map, com.lowagie.text.Document, com.lowagie.text.DocumentException, com.lowagie.text.PageSize, com.lowagie.text.pdf.PdfWriter, jakarta.servlet.http.HttpServletRequest, .HttpServletResponse, org.springframework.web.servlet.view.AbstractView
Abstract superclass for PDF views. Application-specific view classes will extend this class. The view will be held in the subclass itself, not in a template.

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.

Note

Internet Explorer requires a ".pdf" extension, as it doesn't always respect the declared content type.

Authors
Rod Johnson, Juergen Hoeller, Jean-Pierre Pawlak
See Also
AbstractPdfStamperView

Field Summary

Inherited from org.springframework.web.servlet.view.AbstractView:
DEFAULT_CONTENT_TYPE

Constructor Summary

AccessConstructor and Description
public
AbstractPdfView()

This constructor sets the appropriate content type "application/pdf".

Method Summary

Modifier and TypeMethod and Description
protected abstract void
buildPdfDocument(Map<String, Object>
the model Map
model, com.lowagie.text.Document
the iText Document to add elements to
document, com.lowagie.text.pdf.PdfWriter
the PdfWriter to use
writer, 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 build an iText PDF document, given the model.

protected void
buildPdfMetadata(Map<String, Object>
the model, in case meta information must be populated from it
model, com.lowagie.text.Document
the iText document being populated
document, HttpServletRequest
in case we need locale etc. Shouldn't look at attributes.
request)

Populate the iText Document's meta fields (author, title, etc.).

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 int

Returns:

an int containing the bits information against PdfWriter definitions
getViewerPreferences()

Return the viewer preferences for the PDF file.

protected com.lowagie.text.Document

Returns:

the newly created iText Document instance
newDocument()

Create a new document to hold the PDF contents.

protected com.lowagie.text.pdf.PdfWriter

Returns:

the PdfWriter instance to use
newWriter(com.lowagie.text.Document
the iText Document to create a writer for
document, OutputStream
the OutputStream to write to
os)

Create a new PdfWriter for the given iText Document.

protected void
prepareWriter(Map<String, Object>
the model, in case meta information must be populated from it
model, com.lowagie.text.pdf.PdfWriter
the PdfWriter to prepare
writer, HttpServletRequest
in case we need locale etc. Shouldn't look at attributes.
request)

Prepare the given PdfWriter.

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.AbstractView:
addStaticAttributecreateMergedOutputModelcreateRequestContextcreateTemporaryOutputStreamexposeModelAsRequestAttributesformatViewNamegetAttributesMapgetBeanNamegetContentTypegetRequestContextAttributegetRequestToExposegetStaticAttributesisExposePathVariablesprepareResponserendersetAttributessetAttributesCSVsetAttributesMapsetBeanNamesetContentTypesetExposeContextBeansAsAttributessetExposedContextBeanNamessetExposePathVariablessetRequestContextAttributesetResponseContentTypetoStringwriteToResponse

Constructor Detail

AbstractPdfViewback to summary
public AbstractPdfView()

This constructor sets the appropriate content type "application/pdf". Note that IE won't take much notice of this, but there's not a lot we can do about this. Generated documents should have a ".pdf" extension.

Method Detail

buildPdfDocumentback to summary
protected abstract void buildPdfDocument(Map<String, Object> model, com.lowagie.text.Document document, com.lowagie.text.pdf.PdfWriter writer, HttpServletRequest request, HttpServletResponse response) throws Exception

Subclasses must implement this method to build an iText PDF document, given the model. Called between Document.open() and Document.close() calls.

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

document:com.lowagie.text.Document

the iText Document to add elements to

writer:com.lowagie.text.pdf.PdfWriter

the PdfWriter to use

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
See Also
com.lowagie.text.Document#open(), com.lowagie.text.Document#close()
buildPdfMetadataback to summary
protected void buildPdfMetadata(Map<String, Object> model, com.lowagie.text.Document document, HttpServletRequest request)

Populate the iText Document's meta fields (author, title, etc.).
Default is an empty implementation. Subclasses may override this method to add meta fields such as title, subject, author, creator, keywords, etc. This method is called after assigning a PdfWriter to the Document and before calling document.open().

Parameters
model:Map<String, Object>

the model, in case meta information must be populated from it

document:com.lowagie.text.Document

the iText document being populated

request:HttpServletRequest

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

See Also
com.lowagie.text.Document#addTitle, com.lowagie.text.Document#addSubject, com.lowagie.text.Document#addKeywords, com.lowagie.text.Document#addAuthor, com.lowagie.text.Document#addCreator, com.lowagie.text.Document#addProducer, com.lowagie.text.Document#addCreationDate, com.lowagie.text.Document#addHeader
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
getViewerPreferencesback to summary
protected int getViewerPreferences()

Return the viewer preferences for the PDF file.

By default returns AllowPrinting and PageLayoutSinglePage, but can be subclassed. The subclass can either have fixed preferences or retrieve them from bean properties defined on the View.

Returns:int

an int containing the bits information against PdfWriter definitions

See Also
com.lowagie.text.pdf.PdfWriter#AllowPrinting, com.lowagie.text.pdf.PdfWriter#PageLayoutSinglePage
newDocumentback to summary
protected com.lowagie.text.Document newDocument()

Create a new document to hold the PDF contents.

By default returns an A4 document, but the subclass can specify any Document, possibly parameterized via bean properties defined on the View.

Returns:com.lowagie.text.Document

the newly created iText Document instance

See Also
com.lowagie.text.Document#Document(com.lowagie.text.Rectangle)
newWriterback to summary
protected com.lowagie.text.pdf.PdfWriter newWriter(com.lowagie.text.Document document, OutputStream os) throws com.lowagie.text.DocumentException

Create a new PdfWriter for the given iText Document.

Parameters
document:com.lowagie.text.Document

the iText Document to create a writer for

os:OutputStream

the OutputStream to write to

Returns:com.lowagie.text.pdf.PdfWriter

the PdfWriter instance to use

Exceptions
DocumentException:
if thrown during writer creation
prepareWriterback to summary
protected void prepareWriter(Map<String, Object> model, com.lowagie.text.pdf.PdfWriter writer, HttpServletRequest request) throws com.lowagie.text.DocumentException

Prepare the given PdfWriter. Called before building the PDF document, that is, before the call to Document.open().

Useful for registering a page event listener, for example. The default implementation sets the viewer preferences as returned by this class's getViewerPreferences() method.

Parameters
model:Map<String, Object>

the model, in case meta information must be populated from it

writer:com.lowagie.text.pdf.PdfWriter

the PdfWriter to prepare

request:HttpServletRequest

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

Exceptions
DocumentException:
if thrown during writer preparation
See Also
com.lowagie.text.Document#open(), com.lowagie.text.pdf.PdfWriter#setPageEvent, com.lowagie.text.pdf.PdfWriter#setViewerPreferences, getViewerPreferences()
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