com.konakartadmin.bl

Class AdminFileMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminFileMgr

All Implemented Interfaces:

AdminFileMgrIf

Direct Known Subclasses:

AdminFileMgrEE

public class AdminFileMgr
extends AdminBaseMgr
implements AdminFileMgrIf

Manages Files for KonaKartAdmin

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 java.lang.String	imageIOInitMutex Mutex for ImageIO initialisation
protected static java.lang.String	imageIOReadMutex Mutex for ImageIO reads
protected static boolean	initialisedImageIO Indicates whether or not ImageIO has been initialised
private static java.util.Comparator<java.io.File>	lastModifiedAtTopOrdering
protected static org.apache.commons.logging.Log	log
protected static java.util.Set<java.lang.String>	permittedLocations Permitted Locations for File I/O
protected static boolean	synchroniseImageIOReads Indicates whether or not ImageIO Reads should be synchronised for thread-safety reasons

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

Method Summary

Modifier and Type	Method and Description
void	addImage(AdminImageOptions options) Add the image to the object defined in the AdminImageOptions object.
void	checkFileAccess(java.lang.String fileName) Check that we allow access to this location according to the permitted locations as specified in the konakartadmin.properties file
void	checkFileAccess(java.lang.String fileName, java.util.Set<java.lang.String> _permittedLocations) Check that we allow access to this location
boolean	copyFile(java.lang.String srcFileName, java.lang.String dstFileName) Copy the source file to the destination file.
boolean	copyFiles(java.lang.String[] srcFileNames, java.lang.String[] dstFileNames) Copy the source file to the destination file.
boolean	deleteFile(java.lang.String fileName) Delete the file.
AdminFile[]	getConfigFiles() Returns an array containing the configuration files.
java.lang.String	getFileContents(java.lang.String fileName) Get the file contents.
java.lang.String	getFileContents(java.lang.String fileName, int offset) Get the file contents from the specified offset.
byte[]	getFileContentsAsByteArray(java.lang.String fileName) Get the file contents as a byte array.
AdminFile[]	getFiles(java.lang.String directory, java.lang.String extension) Returns an array of files found in the directory.
protected java.util.Set<java.lang.String>	getPermittedLocations() Parses the konakart.permittedLocations property value in konakartadmin.properties to find the permitted locations for file I/O.
protected void	initImageIO()
protected static boolean	isSynchroniseImageIOReads()
void	refreshConfigs() Refresh the configuration of the Manager
void	removeImage(AdminImageOptions options) Remove the image (or images) from the object defined in the AdminImageOptions object.
boolean	renameFile(java.lang.String srcFileName, java.lang.String dstFileName) Rename the source file to the destination file.
boolean	renameFiles(java.lang.String[] srcFileNames, java.lang.String[] dstFileNames) Rename the source files to the destination files.
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.
void	saveFileContents(java.lang.String fileName, java.lang.String fileContents) Writes the specified file contents into the specified file.
boolean	scaleImage(AdminScaleOptions scaleOptions) Scale the specified image to the specified name and dimensions.
protected static void	setSynchroniseImageIOReads(boolean synchroniseImageIOReads)

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

initialisedImageIO

protected static boolean initialisedImageIO

Indicates whether or not ImageIO has been initialised

synchroniseImageIOReads

protected static boolean synchroniseImageIOReads

Indicates whether or not ImageIO Reads should be synchronised for thread-safety reasons

imageIOInitMutex

protected static java.lang.String imageIOInitMutex

Mutex for ImageIO initialisation

permittedLocations

protected static java.util.Set<java.lang.String> permittedLocations

Permitted Locations for File I/O

imageIOReadMutex

protected static java.lang.String imageIOReadMutex

Mutex for ImageIO reads

lastModifiedAtTopOrdering

private static final java.util.Comparator<java.io.File> lastModifiedAtTopOrdering

Constructor Detail

AdminFileMgr

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

The AdminFileMgr constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

checkFileAccess

public void checkFileAccess(java.lang.String fileName)
                     throws KKAdminException

Check that we allow access to this location according to the permitted locations as specified in the konakartadmin.properties file

Specified by:

checkFileAccess in interface AdminFileMgrIf

Parameters:

fileName - the file to be accessed (read or written)

Throws:

KKAdminException - if access to the filepath isn't permitted a Exception is thrown otherwise the method returns successfully.

checkFileAccess

public void checkFileAccess(java.lang.String fileName,
                            java.util.Set<java.lang.String> _permittedLocations)
                     throws KKAdminException

Check that we allow access to this location

Specified by:

checkFileAccess in interface AdminFileMgrIf

Parameters:

fileName - the file to be accessed (read or written)

_permittedLocations - a set of Strings that are sub-strings of filepaths of permitted locations. A normalised filepath is permitted if it contains one of the permitted location substrings.

Throws:

KKAdminException - if access to the filepath isn't permitted a KKAdminException is thrown otherwise the method returns successfully.

getFileContents

public java.lang.String getFileContents(java.lang.String fileName)
                                 throws KKAdminException

Get the file contents. Note that it uses the line terminators appropriate for the platform where the file resides.

Specified by:

getFileContents in interface AdminFileMgrIf

Parameters:

fileName - the filename in the server's context

Returns:

the file contents as a String

Throws:

KKAdminException - if the file's not present or can't be read, or it's not a text file

getFileContents

public java.lang.String getFileContents(java.lang.String fileName,
                                        int offset)
                                 throws KKAdminException

Get the file contents from the specified offset. Note that it uses the line terminators appropriate for the platform where the file resides.

Specified by:

getFileContents in interface AdminFileMgrIf

Parameters:

fileName - the filename in the server's context

offset - the offset from the start of the file in bytes

Returns:

the file contents as a String

Throws:

KKAdminException - if the file's not present or can't be read, or it's not a text file

saveFileContents

public void saveFileContents(java.lang.String fileName,
                             java.lang.String fileContents)
                      throws KKAdminException

Writes the specified file contents into the specified file. It creates the file if it doesn't already exist.

Specified by:

saveFileContents in interface AdminFileMgrIf

Parameters:

fileName - the filename in the server's context

fileContents - the file contents to write

Throws:

KKAdminException - on any Security or IO problems that prevent us from saving the data to the file or if the API call is disabled

deleteFile

public boolean deleteFile(java.lang.String fileName)
                   throws KKAdminException

Delete the file.

Specified by:

deleteFile in interface AdminFileMgrIf

Parameters:

fileName - the filename in the server's context

Returns:

true if the file was deleted, otherwise false.

Throws:

KKAdminException - if the file's not present or can't be deleted or if the API call is disabled

copyFiles

public boolean copyFiles(java.lang.String[] srcFileNames,
                         java.lang.String[] dstFileNames)
                  throws KKAdminException

Copy the source file to the destination file.

Specified by:

copyFiles in interface AdminFileMgrIf

Parameters:

srcFileNames - the filename in the server's context to copy from

dstFileNames - the filename in the server's context to copy to

Returns:

true if the file was copied successfully, otherwise an exception is thrown.

Throws:

KKAdminException - if the source file's not present or can't be copied or if the API call is disabled

copyFile

public boolean copyFile(java.lang.String srcFileName,
                        java.lang.String dstFileName)
                 throws KKAdminException

Copy the source file to the destination file.

Specified by:

copyFile in interface AdminFileMgrIf

Parameters:

srcFileName - the filename in the server's context to copy from

dstFileName - the filename in the server's context to copy to

Returns:

true if the file was copied successfully, otherwise an exception is thrown.

Throws:

KKAdminException - if the source file's not present or can't be copied or if the API call is disabled

renameFiles

public boolean renameFiles(java.lang.String[] srcFileNames,
                           java.lang.String[] dstFileNames)
                    throws KKAdminException

Rename the source files to the destination files.

Specified by:

renameFiles in interface AdminFileMgrIf

Parameters:

srcFileNames - an array of filenames in the server's context to rename from

dstFileNames - an array of filenames in the server's context to rename to

Returns:

true if the file was copied successfully, otherwise an exception is thrown.

Throws:

KKAdminException - if any of the source file are not present or can't be renamed

renameFile

public boolean renameFile(java.lang.String srcFileName,
                          java.lang.String dstFileName)
                   throws KKAdminException

Rename the source file to the destination file.

Specified by:

renameFile in interface AdminFileMgrIf

Parameters:

srcFileName - the filename in the server's context to rename from

dstFileName - the filename in the server's context to rename to

Returns:

true if the file was renamed successfully, otherwise an exception is thrown.

Throws:

KKAdminException - if the source file's not present or can't be renamed

getConfigFiles

public AdminFile[] getConfigFiles()
                           throws KKAdminException

Description copied from interface: AdminFileMgrIf

Returns an array containing the configuration files.

Specified by:

getConfigFiles in interface AdminFileMgrIf

Returns:

Returns the files defined in konakart-files.xml

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getFiles

public AdminFile[] getFiles(java.lang.String directory,
                            java.lang.String extension)
                     throws KKAdminException

Returns an array of files found in the directory. If the extension is not null, then the files are filtered by extension and ordered by lastModified date.

Specified by:

getFiles in interface AdminFileMgrIf

Parameters:

directory - the directory

extension - the extension

Returns:

Returns an array of Admin File objects

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getFileContentsAsByteArray

public byte[] getFileContentsAsByteArray(java.lang.String fileName)
                                  throws KKAdminException

Get the file contents as a byte array.

Specified by:

getFileContentsAsByteArray in interface AdminFileMgrIf

Parameters:

fileName - the filename in the server's context

Returns:

the file contents as a vte array

Throws:

KKAdminException - if the file's not present or can't be read

scaleImage

public boolean scaleImage(AdminScaleOptions scaleOptions)
                   throws KKAdminException

Scale the specified image to the specified name and dimensions. Supported image extensions are: JPG, JPEG, GIF and PNG.

Specified by:

scaleImage in interface AdminFileMgrIf

Parameters:

scaleOptions - The scaling options

Returns:

true if the file was scaled and created successfully

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

initImageIO

protected void initImageIO()

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

Parameters:

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

Throws:

KKAdminException - if the image was not added successfully

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

Parameters:

options - The options that define which images should be removed

Throws:

KKAdminException - for any unexpected problems

isSynchroniseImageIOReads

protected static boolean isSynchroniseImageIOReads()

Returns:

the synchroniseImageIOReads

setSynchroniseImageIOReads

protected static void setSynchroniseImageIOReads(boolean synchroniseImageIOReads)

Parameters:

synchroniseImageIOReads - the synchroniseImageIOReads to set

getPermittedLocations

protected java.util.Set<java.lang.String> getPermittedLocations()

Parses the konakart.permittedLocations property value in konakartadmin.properties to find the permitted locations for file I/O.

Returns:

the permitted locations in a set

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Manager

Specified by:

refreshConfigs in interface AdminFileMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

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 loacl and remote base paths can be different..

Specified by:

rsyncDirectory in interface AdminFileMgrIf

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