org.mapfish.print.servlet

Class MapPrinterServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.mapfish.print.servlet.BaseMapServlet

org.mapfish.print.servlet.MapPrinterServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class MapPrinterServlet
extends BaseMapServlet

Main print servlet.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	SPEC_LOGGER
protected static java.lang.String	TEMP_FILE_PREFIX

Fields inherited from class org.mapfish.print.servlet.BaseMapServlet

LOGGER

Constructor Summary

Constructors

Constructor and Description
MapPrinterServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTempFile(org.mapfish.print.servlet.MapPrinterServlet.TempFile tempFile, java.lang.String id)
protected void	createAndGetPDF(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) All in one method: create and returns the PDF to the client.
protected void	createPDF(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String basePath) Create the PDF and returns to the client (in JSON) the URL to get the PDF.
protected void	deleteFile(java.io.File file) If the file is defined, delete it.
void	destroy()
protected org.mapfish.print.servlet.MapPrinterServlet.TempFile	doCreatePDFFile(java.lang.String spec, javax.servlet.http.HttpServletRequest httpServletRequest) Do the actual work of creating the PDF temporary file.
protected void	doGet(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
protected void	doPost(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
protected void	error(javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String message, int code) Send an error XXX to the client with a message
protected void	error(javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.Throwable e) Send an error XXX to the client with an exception
protected java.lang.String	generateId(java.io.File tempFile) Get the ID to use in function of the filename (filename without the prefix and the extension).
protected java.lang.String	getBaseUrl(javax.servlet.http.HttpServletRequest httpServletRequest)
protected java.lang.String	getEncoding() Get and cache the used Encoding.
protected void	getFile(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String id) To get the PDF created previously.
protected void	getInfo(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, java.lang.String basePath) To get (in JSON) the information about the available formats and CO.
protected java.lang.String	getSpecFromPostBody(javax.servlet.http.HttpServletRequest httpServletRequest)
protected java.io.File	getTempDir() Get and cache the temporary directory to use for saving the generated PDF files.
void	init()
protected void	purgeOldTemporaryFiles() Will purge all the known temporary files older than TEMP_FILE_PURGE_SECONDS.
protected void	sendPdfFile(javax.servlet.http.HttpServletResponse httpServletResponse, org.mapfish.print.servlet.MapPrinterServlet.TempFile tempFile, boolean inline) copy the PDF into the output stream

Methods inherited from class org.mapfish.print.servlet.BaseMapServlet

getMapPrinter

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPEC_LOGGER

public static final org.apache.log4j.Logger SPEC_LOGGER

TEMP_FILE_PREFIX

protected static final java.lang.String TEMP_FILE_PREFIX

See Also:

Constant Field Values

Constructor Detail

MapPrinterServlet

public MapPrinterServlet()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest httpServletRequest,
         javax.servlet.http.HttpServletResponse httpServletResponse)
              throws javax.servlet.ServletException,
                     java.io.IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest httpServletRequest,
          javax.servlet.http.HttpServletResponse httpServletResponse)
               throws javax.servlet.ServletException,
                      java.io.IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

createAndGetPDF

protected void createAndGetPDF(javax.servlet.http.HttpServletRequest httpServletRequest,
                   javax.servlet.http.HttpServletResponse httpServletResponse)

All in one method: create and returns the PDF to the client. Avoid to use it, the accents in the spec are not all supported.

createPDF

protected void createPDF(javax.servlet.http.HttpServletRequest httpServletRequest,
             javax.servlet.http.HttpServletResponse httpServletResponse,
             java.lang.String basePath)
                  throws javax.servlet.ServletException

Create the PDF and returns to the client (in JSON) the URL to get the PDF.

Throws:

javax.servlet.ServletException

addTempFile

protected void addTempFile(org.mapfish.print.servlet.MapPrinterServlet.TempFile tempFile,
               java.lang.String id)

getSpecFromPostBody

protected java.lang.String getSpecFromPostBody(javax.servlet.http.HttpServletRequest httpServletRequest)
                                        throws java.io.IOException

Throws:

java.io.IOException

getEncoding

protected java.lang.String getEncoding()

Get and cache the used Encoding.

getFile

protected void getFile(javax.servlet.http.HttpServletRequest req,
           javax.servlet.http.HttpServletResponse httpServletResponse,
           java.lang.String id)
                throws java.io.IOException,
                       javax.servlet.ServletException

To get the PDF created previously.

Throws:

java.io.IOException

javax.servlet.ServletException

getInfo

protected void getInfo(javax.servlet.http.HttpServletRequest req,
           javax.servlet.http.HttpServletResponse resp,
           java.lang.String basePath)
                throws javax.servlet.ServletException,
                       java.io.IOException

To get (in JSON) the information about the available formats and CO.

Throws:

javax.servlet.ServletException

java.io.IOException

doCreatePDFFile

protected org.mapfish.print.servlet.MapPrinterServlet.TempFile doCreatePDFFile(java.lang.String spec,
                                                                   javax.servlet.http.HttpServletRequest httpServletRequest)
                                                                        throws java.io.IOException,
                                                                               com.itextpdf.text.DocumentException,
                                                                               javax.servlet.ServletException,
                                                                               java.lang.InterruptedException

Do the actual work of creating the PDF temporary file.

Throws:

java.lang.InterruptedException

java.io.IOException

com.itextpdf.text.DocumentException

javax.servlet.ServletException

sendPdfFile

protected void sendPdfFile(javax.servlet.http.HttpServletResponse httpServletResponse,
               org.mapfish.print.servlet.MapPrinterServlet.TempFile tempFile,
               boolean inline)
                    throws java.io.IOException,
                           javax.servlet.ServletException

copy the PDF into the output stream

Throws:

java.io.IOException

javax.servlet.ServletException

error

protected void error(javax.servlet.http.HttpServletResponse httpServletResponse,
         java.lang.Throwable e)

Send an error XXX to the client with an exception

error

protected void error(javax.servlet.http.HttpServletResponse httpServletResponse,
         java.lang.String message,
         int code)

Send an error XXX to the client with a message

getTempDir

protected java.io.File getTempDir()

Get and cache the temporary directory to use for saving the generated PDF files.

deleteFile

protected void deleteFile(java.io.File file)

If the file is defined, delete it.

generateId

protected java.lang.String generateId(java.io.File tempFile)

Get the ID to use in function of the filename (filename without the prefix and the extension).

getBaseUrl

protected java.lang.String getBaseUrl(javax.servlet.http.HttpServletRequest httpServletRequest)

purgeOldTemporaryFiles

protected void purgeOldTemporaryFiles()

Will purge all the known temporary files older than TEMP_FILE_PURGE_SECONDS.