com.konakartadmin.bl

Class AdminFileMgrEE

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminFileMgr

com.konakartadmin.bl.AdminFileMgrEE

All Implemented Interfaces:

AdminFileMgrIf

public class AdminFileMgrEE
extends AdminFileMgr
implements AdminFileMgrIf

Manages Files for KonaKartAdmin - Enterprise version

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log

Fields inherited from class com.konakartadmin.bl.AdminFileMgr

imageIOInitMutex, imageIOReadMutex, initialisedImageIO, permittedLocations, synchroniseImageIOReads

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
AdminFileMgrEE(KKAdminIf eng) The AdminFileMgr constructor

Method Summary

Modifier and Type	Method and Description
void	addCategoryImage(AdminImageOptions options) Add a Category Image using the same configuration as the Admin App uses which is defined in konakartadmin_gwt.properties.
protected java.lang.String	addCRC(java.lang.String imageCrc, int nextImageIdx, java.lang.String crc, java.lang.String fileSize)
void	addImage(AdminImageOptions options) Add the image to the object defined in the AdminImageOptions object.
void	addManufacturerImage(AdminImageOptions options) Add a Manufacturer Image using the same configuration as the Admin App uses which is defined in konakartadmin_gwt.properties.
void	addProductImage(AdminImageOptions options) Add a Product Image using the same configuration as the Admin App uses in konakartadmin_gwt.properties.
protected void	copyFromRemote(java.lang.String remoteSessionId, KKAdminIf remoteEng, java.lang.String remotefileName, java.lang.String localfileName)
protected void	purgeDirectoryFiles(java.lang.String dirName, java.lang.String pattern, int filesToRetain)
void	removeCategoryImage(AdminImageOptions options) Remove the Category's Image from disk (if it's the only Category using the image) and from the Category's record in the database
void	removeImage(AdminImageOptions options) Remove the image (or images) from the object defined in the AdminImageOptions object.
void	removeManufacturerImage(AdminImageOptions options) Remove the Manufacturer's Image from disk and from the Manufacturer's record in the database
void	removeProductImage(AdminImageOptions options) Remove the Product's Image(s) from disk.
int	rsyncDirectory(java.lang.String remoteSessionId, KKAdminIf remoteEng, java.lang.String localSessionId, KKAdminIf localEng, java.lang.String remoteDir, java.lang.String localDir) Sync the files in the specified directory using a local and a remote engine.

Methods inherited from class com.konakartadmin.bl.AdminFileMgr

checkFileAccess, checkFileAccess, copyFile, copyFiles, deleteFile, getConfigFiles, getFileContents, getFileContents, getFileContentsAsByteArray, getFiles, getPermittedLocations, initImageIO, isSynchroniseImageIOReads, refreshConfigs, renameFile, renameFiles, saveFileContents, scaleImage, setSynchroniseImageIOReads

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

Methods inherited from interface com.konakartadmin.blif.AdminFileMgrIf

checkFileAccess, checkFileAccess, copyFile, copyFiles, deleteFile, getConfigFiles, getFileContents, getFileContents, getFileContentsAsByteArray, getFiles, refreshConfigs, renameFile, renameFiles, saveFileContents, scaleImage

Field Detail

log

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

Constructor Detail

AdminFileMgrEE

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

The AdminFileMgr constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

addImage

public void addImage(AdminImageOptions options)
              throws KKAdminException

Description copied from interface: AdminFileMgrIf

Add the image to the object defined in the AdminImageOptions object.

When adding product images it uses the same conventions as used in the Admin Application and gets these definitions from the konakartadmin_gwt.properties file. Once an image is added to a product using this API the image will appear for the product in the Admin Application just as if it had been added via an image upload in the Admin application.

Specified by:

addImage in interface AdminFileMgrIf

Overrides:

addImage in class AdminFileMgr

Parameters:

options - The options that define which object the image should be added to

Throws:

KKAdminException - if the image was not added successfully

addProductImage

public void addProductImage(AdminImageOptions options)
                     throws KKAdminException

Add a Product Image using the same configuration as the Admin App uses in konakartadmin_gwt.properties. Only the current Admin App Image Tab configuration (Image Tab Version 2) is supported.

Parameters:

options - the options

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

purgeDirectoryFiles

protected void purgeDirectoryFiles(java.lang.String dirName,
                                   java.lang.String pattern,
                                   int filesToRetain)

addCRC

protected java.lang.String addCRC(java.lang.String imageCrc,
                                  int nextImageIdx,
                                  java.lang.String crc,
                                  java.lang.String fileSize)

addManufacturerImage

public void addManufacturerImage(AdminImageOptions options)
                          throws KKAdminException

Add a Manufacturer Image using the same configuration as the Admin App uses which is defined in konakartadmin_gwt.properties.

Parameters:

options - the options

Throws:

KKAdminException - if there are any problems such as the source file does not exist.

addCategoryImage

public void addCategoryImage(AdminImageOptions options)
                      throws KKAdminException

Add a Category Image using the same configuration as the Admin App uses which is defined in konakartadmin_gwt.properties.

Parameters:

options - the options

Throws:

KKAdminException - if there are any problems such as the source file does not exist.

removeImage

public void removeImage(AdminImageOptions options)
                 throws KKAdminException

Description copied from interface: AdminFileMgrIf

Remove the image (or images) from the object defined in the AdminImageOptions object.

Specified by:

removeImage in interface AdminFileMgrIf

Overrides:

removeImage in class AdminFileMgr

Parameters:

options - The options that define which images should be removed

Throws:

KKAdminException - for any unexpected problems

removeProductImage

public void removeProductImage(AdminImageOptions options)
                        throws KKAdminException

Remove the Product's Image(s) from disk.

Parameters:

options - Specify the subject (KKConstants.IMG_PRODUCT), the id (productId) and a pattern for filename selection

Throws:

KKAdminException - if the Product has no image defined or there is an unexpected I/O or database problem.

removeManufacturerImage

public void removeManufacturerImage(AdminImageOptions options)
                             throws KKAdminException

Remove the Manufacturer's Image from disk and from the Manufacturer's record in the database

Parameters:

options - only necessary to specify the subject and the id for removing Manufacturer images

Throws:

KKAdminException - if the Manufacturer has no image defined or there is an unexpected I/O or database problem.

removeCategoryImage

public void removeCategoryImage(AdminImageOptions options)
                         throws KKAdminException

Remove the Category's Image from disk (if it's the only Category using the image) and from the Category's record in the database

Parameters:

options - only necessary to specify the subject and the id for removing Category images

Throws:

KKAdminException - if the Category has no image defined or there is an unexpected I/O or database problem.

rsyncDirectory

public int rsyncDirectory(java.lang.String remoteSessionId,
                          KKAdminIf remoteEng,
                          java.lang.String localSessionId,
                          KKAdminIf localEng,
                          java.lang.String remoteDir,
                          java.lang.String localDir)
                   throws KKAdminException

Sync the files in the specified directory using a local and a remote engine. Files are only ever copied from remote to local systems. The directory name must be the same but the local and remote base paths can be different.

Specified by:

rsyncDirectory in interface AdminFileMgrIf

Overrides:

rsyncDirectory in class AdminFileMgr

Parameters:

remoteSessionId - sessionId for the remote engine

remoteEng - the remote engine (probably a KKJSONAdminEng)

localSessionId - the local sessionId (could be the same as the remote sessionId for systems sharing the same database)

localEng - the local engine

remoteDir - remote base directory

localDir - local base directory (often the same as the remote base directory)

Returns:

returns the number of files updated

Throws:

KKAdminException - an unexpected exception in the KKAdmin engine

copyFromRemote

protected void copyFromRemote(java.lang.String remoteSessionId,
                              KKAdminIf remoteEng,
                              java.lang.String remotefileName,
                              java.lang.String localfileName)
                       throws KKAdminException,
                              java.io.IOException

Throws:

KKAdminException

java.io.IOException