com.konakartadmin.bl

Class AdminPdfMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminPdfMgr

All Implemented Interfaces:

AdminPdfMgrIf

public class AdminPdfMgr
extends AdminBaseMgr
implements AdminPdfMgrIf

The AdminPdfMgr - for creating various PDFs for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminPdfMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex
protected static java.util.Map<java.lang.String,AdminPdfMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminPdfMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	createPdfDirNameAfterBase(PdfOptions options) Returns the directory name (after the base part) where the PDF file will be generated
java.lang.String	createPdfFileNameLastPart(PdfOptions options) For creating a file name for the PDF file to be generated.
void	createPDFFromHTML(PdfOptions options, java.lang.String html, java.lang.String pdfFileName) Created the PDF file from the specified HTML String
java.lang.String	getFullPdfFileName(java.lang.String dirPath, java.lang.String pdfFileNameAfterBasePath) For creating a file name for the PDF file to be generated
PdfResult	getPdf(PdfOptions options) Create the PDF document and return the URL, File name or bytes as defined by the input options.
java.lang.String	getPdfFileBasePath() Get the base path for the PDF files from the configuration parameter.
java.lang.String	getUUID() Returns a UUID to add to the PDF file name to make it unique and hard to guess
java.lang.String	modifyHtml(java.lang.String html) A customisation point to allow for modification of the HTML prior to being converted to PDF
void	refreshConfigs() Retrieve some commonly-used properties and set the velocity log file location
org.xhtmlrenderer.pdf.ITextRenderer	renderHtml(java.lang.String html) Render the HTML and return the ITextRenderer object for further processing

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

staticDataHM

protected static java.util.Map<java.lang.String,AdminPdfMgr.StaticData> staticDataHM

Hash Map that contains the static data

Constructor Detail

AdminPdfMgr

public AdminPdfMgr(KKAdminIf eng)
            throws java.lang.Exception

Constructor

Parameters:

eng - KKAdmin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getPdf

public PdfResult getPdf(PdfOptions options)
                 throws java.lang.Exception

Create the PDF document and return the URL, File name or bytes as defined by the input options.

Specified by:

getPdf in interface AdminPdfMgrIf

Parameters:

options - the options that define the PDF report to be produced and what is returned from this interface. If the html attribute on PdfOptions is set this is used as the source for the PDF otherwise getHtml on the AdminHgetAdminHtmlMgr is called to produce the HTML.

Returns:

a PdfResult object containing information that is defined in the options specified on input.

Throws:

java.lang.Exception - an unexpected exception

createPdfDirNameAfterBase

public java.lang.String createPdfDirNameAfterBase(PdfOptions options)

Returns the directory name (after the base part) where the PDF file will be generated

Parameters:

options - The PdfOptions that were specified for creating the PDF file

Returns:

the PDF directory name that comes after the base directory

createPdfFileNameLastPart

public java.lang.String createPdfFileNameLastPart(PdfOptions options)

For creating a file name for the PDF file to be generated. This creates the name that will be added to the directory name.

Parameters:

options - The PdfOptions that were specified for creating the PDF file

Returns:

the generated PDF file name - just the last part after the directories

getFullPdfFileName

public java.lang.String getFullPdfFileName(java.lang.String dirPath,
                                           java.lang.String pdfFileNameAfterBasePath)

For creating a file name for the PDF file to be generated

Parameters:

dirPath - the directory path for the PDF files

pdfFileNameAfterBasePath - The PDF file name appended after the base path

Returns:

the generated PDF file name

getPdfFileBasePath

public java.lang.String getPdfFileBasePath()
                                    throws KKAdminException

Get the base path for the PDF files from the configuration parameter.

Returns:

the PDF Files base path

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getUUID

public java.lang.String getUUID()

Returns a UUID to add to the PDF file name to make it unique and hard to guess

Returns:

a randomly-generated UUID in a String

createPDFFromHTML

public void createPDFFromHTML(PdfOptions options,
                              java.lang.String html,
                              java.lang.String pdfFileName)
                       throws java.lang.Exception

Created the PDF file from the specified HTML String

Specified by:

createPDFFromHTML in interface AdminPdfMgrIf

Parameters:

options - the PdfOptions options object which might one day be used to affect the PDF generation if this method is overriden.

html - the HTML String to convert into a PDF file

pdfFileName - the target pdfFileName

Throws:

java.lang.Exception - an unexpected exception

modifyHtml

public java.lang.String modifyHtml(java.lang.String html)
                            throws java.lang.Exception

A customisation point to allow for modification of the HTML prior to being converted to PDF

Specified by:

modifyHtml in interface AdminPdfMgrIf

Parameters:

html - the HTML to modify

Returns:

the modified HTML

Throws:

java.lang.Exception - an unexpected exception

renderHtml

public org.xhtmlrenderer.pdf.ITextRenderer renderHtml(java.lang.String html)

Render the HTML and return the ITextRenderer object for further processing

Parameters:

html - the html

Returns:

the ITextRenderer object that contains the parsed HTML document

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Retrieve some commonly-used properties and set the velocity log file location

Specified by:

refreshConfigs in interface AdminPdfMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception