Package org.opencms.pdftools

Class CmsPdfResourceHandler

java.lang.Object

org.opencms.pdftools.CmsPdfResourceHandler

All Implemented Interfaces:

I_CmsResourceInit

public class CmsPdfResourceHandler
extends java.lang.Object
implements I_CmsResourceInit

This resource handler handles URLs of the form /pdflink/{locale}/{formatter-id}/{detailname} and format the content identified by detailname using the JSP identified by formatter-id to generate XHTML which is then converted to PDF and returned directly by this handler.

In Online mode, the generated PDFs are cached on the real file system, while in Offline mode, the PDF data is always generated on-the-fly.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IMAGE_MIMETYPECONFIG	Mime type data for different file extensions.
static java.util.Map<java.lang.String,java.lang.String>	IMAGE_MIMETYPES	Map of mime types for different file extensions.

Fields inherited from interface org.opencms.main.I_CmsResourceInit

ATTR_ALTERNATIVE_CMS_OBJECT

Constructor Summary

Constructors

Constructor	Description
CmsPdfResourceHandler()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	handlePdfLink(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String uri)	Handles a link for generating a PDF.
CmsResource	initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Possibility to modify or change the CmsFile with the CmsObject.
protected void	logXhtmlOutput(CmsResource formatter, CmsResource content, byte[] xhtmlData)	Logs the XHTML output.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.main.I_CmsResourceInit

getConfiguration, initParameters

Field Detail

IMAGE_MIMETYPECONFIG

public static final java.lang.String IMAGE_MIMETYPECONFIG

Mime type data for different file extensions.

See Also:

Constant Field Values

IMAGE_MIMETYPES

public static final java.util.Map<java.lang.String,java.lang.String> IMAGE_MIMETYPES

Map of mime types for different file extensions.

Constructor Detail

CmsPdfResourceHandler

public CmsPdfResourceHandler()

Creates a new instance.

Method Detail

initResource

public CmsResource initResource(CmsResource resource,
                                CmsObject cms,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws CmsResourceInitException,
                                CmsSecurityException

Description copied from interface: I_CmsResourceInit

Possibility to modify or change the CmsFile with the CmsObject.

Caution: reading parameters from the request, destroys special characters in all parameters, because the encoding for the request was not set yet.

Specified by:

initResource in interface I_CmsResourceInit

Parameters:

resource - the requested file

cms - the current CmsObject

request - the current request

response - the current response

Returns:

a resource in the OpenCms VFS

Throws:

CmsResourceInitException - if other implementations of the interface should not be executed

CmsSecurityException - if other implementations of the interface should not be executed, and the security exception should be escalated

See Also:

I_CmsResourceInit.initResource(org.opencms.file.CmsResource, org.opencms.file.CmsObject, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

handlePdfLink

protected void handlePdfLink(CmsObject cms,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             java.lang.String uri)
                      throws java.lang.Exception

Handles a link for generating a PDF.

Parameters:

cms - the current CMS context

request - the servlet request

response - the servlet response

uri - the current uri

Throws:

java.lang.Exception - if something goes wrong

CmsResourceInitException - if the resource initialization is cancelled

logXhtmlOutput

protected void logXhtmlOutput(CmsResource formatter,
                              CmsResource content,
                              byte[] xhtmlData)

Logs the XHTML output.

Parameters:

formatter - the formatter

content - the content resource

xhtmlData - the XHTML data