com.elasticpath.service.misc
Interface FileService

All Superinterfaces:

EpService

All Known Implementing Classes:

FileServiceImpl

public interface FileService
extends EpService

Provides file download and upload service.

Method Summary

boolean	createFolder(java.lang.String rootFolder, java.lang.String subPath) Create the folder.
boolean	deleteEntireFolder(java.lang.String rootFolder, java.lang.String subPath) Delete the folder and all files under it.
boolean	deleteFile(java.lang.String rootFolder, java.lang.String filePath) Delete the file.
void	download(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String fullFilePath) Read the input file content and output the stream to client (Browser).
java.util.ArrayList	getFilesByFolder(java.lang.String rootFolder, java.lang.String subPath) Get the file list under asset sub folder.
java.util.ArrayList	getSubFolders(java.lang.String rootFolder, java.lang.String subPath) Read the sub folders.
boolean	isFileExist(java.lang.String rootFolder, java.lang.String filePath) Check if the file exists.
boolean	renameFile(java.lang.String rootFolder, java.lang.String oriFilePath, java.lang.String newFilePath) Rename the file.

Methods inherited from interface com.elasticpath.service.EpService

getElasticPath, setElasticPath

Method Detail

createFolder

boolean createFolder(java.lang.String rootFolder,
                     java.lang.String subPath)

Create the folder.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

subPath - the subPath under root folder

Returns:

true if the entire folder deleted, otherwise false

deleteEntireFolder

boolean deleteEntireFolder(java.lang.String rootFolder,
                           java.lang.String subPath)

Delete the folder and all files under it.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

subPath - the subPath under root folder

Returns:

true if the entire folder deleted, otherwise false

deleteFile

boolean deleteFile(java.lang.String rootFolder,
                   java.lang.String filePath)

Delete the file.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

filePath - the filePath under root folder

Returns:

true if the entire folder deleted, otherwise false

download

void download(javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response,
              java.lang.String fullFilePath)
              throws EpSystemException

Read the input file content and output the stream to client (Browser).

Parameters:

request - the download request

response - the response

fullFilePath - the full file path on server

Throws:

EpSystemException - - if any error

getFilesByFolder

java.util.ArrayList getFilesByFolder(java.lang.String rootFolder,
                                     java.lang.String subPath)

Get the file list under asset sub folder.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

subPath - the subPath under root folder

Returns:

the list of file name with the sub path under root folder

getSubFolders

java.util.ArrayList getSubFolders(java.lang.String rootFolder,
                                  java.lang.String subPath)

Read the sub folders.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

subPath - the subPath under root folder

Returns:

the sub folder path

isFileExist

boolean isFileExist(java.lang.String rootFolder,
                    java.lang.String filePath)

Check if the file exists.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

filePath - the filePath under root folder

Returns:

true if file exist, otherwise false

renameFile

boolean renameFile(java.lang.String rootFolder,
                   java.lang.String oriFilePath,
                   java.lang.String newFilePath)

Rename the file.

Parameters:

rootFolder - the root folder for different type of asset, e.g., images for image asset

oriFilePath - the filePath under root folder

newFilePath - the filePath under root folder

Returns:

true if rename successful, otherwise false