com.konakartadmin.blif

Interface AdminFileMgrIf

All Known Implementing Classes:

AdminFileMgr, AdminFileMgrEE

public interface AdminFileMgrIf

AdminFileMgrIf

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 files to the destination files.
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 byte 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.
void	refreshConfigs() Refresh the configuration of the Admin File 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.

Method Detail

checkFileAccess

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

Parameters:

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

Throws:

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

checkFileAccess

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

Check that we allow access to this location

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

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.

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

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

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

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

getFileContentsAsByteArray

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

Get the file contents as a byte array.

Parameters:

fileName - the filename in the server's context

Returns:

the file contents as a byte array

Throws:

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

saveFileContents

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.

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

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

Delete the file.

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

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

Copy the source files to the destination files.

Parameters:

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

dstFileNames - an array of filenames in the server's context to copy 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 copied

copyFile

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

Copy the source file to the destination file.

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.

renameFile

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

Rename the source file to the destination file.

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

renameFiles

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

Rename the source files to the destination files.

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

getConfigFiles

AdminFile[] getConfigFiles()
                    throws KKAdminException

Returns an array containing the configuration files.

Returns:

Returns the files defined in konakart-files.xml

Throws:

KKAdminException - an unexpected KKAdminException exception

getFiles

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.

Parameters:

directory - The directory containing the files

extension - The extension of the files. If null, all files are returned.

Returns:

Returns an array of Admin File objects

Throws:

KKAdminException - an unexpected KKAdminException exception

scaleImage

boolean scaleImage(AdminScaleOptions scaleOptions)
            throws KKAdminException

Scale the specified image to the specified name and dimensions.

Parameters:

scaleOptions - The scaling options

Returns:

true if the file was scaled and created successfully

Throws:

KKAdminException - throws an exception of the scaling operation was unsuccessful

addImage

void addImage(AdminImageOptions options)
       throws KKAdminException

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.

Parameters:

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

Throws:

KKAdminException - if the image was not added successfully

removeImage

void removeImage(AdminImageOptions options)
          throws KKAdminException

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

Parameters:

options - The options that define which images should be removed

Throws:

KKAdminException - for any unexpected problems

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Admin File Manager

Throws:

java.lang.Exception - an unexpected exception

rsyncDirectory

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.

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