public abstract class AbstractPdfStamperView extends AbstractUrlBasedView
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!
AbstractPdfView
DEFAULT_CONTENT_TYPE
logger
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
Constructor and Description |
---|
AbstractPdfStamperView() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
generatesDownloadContent()
Return whether this view generates download content
(typically binary content like PDF or Excel files).
|
protected abstract void |
mergePdfDocument(Map<String,Object> model,
com.lowagie.text.pdf.PdfStamper stamper,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to merge the PDF form
with the given model data.
|
protected com.lowagie.text.pdf.PdfReader |
readPdfResource()
Read the raw PDF resource into an iText PdfReader.
|
protected void |
renderMergedOutputModel(Map<String,Object> model,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to actually render the view.
|
afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
protected boolean generatesDownloadContent()
AbstractView
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.
protected final void renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception
AbstractView
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.
renderMergedOutputModel
in class AbstractView
model
- combined output Map (never null
),
with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP responseException
- if rendering failedprotected com.lowagie.text.pdf.PdfReader readPdfResource() throws IOException
The default implementation resolve the specified "url" property as ApplicationContext resource.
IOException
- if resource access failedAbstractUrlBasedView.setUrl(java.lang.String)
protected abstract void mergePdfDocument(Map<String,Object> model, com.lowagie.text.pdf.PdfStamper stamper, HttpServletRequest request, HttpServletResponse response) throws Exception
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", "Vvlue2"); // 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.
model
- the model Mapstamper
- 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
- in case we need locale etc. Shouldn't look at attributes.response
- in case we need to set cookies. Shouldn't write to it.Exception
- any exception that occurred during document building