com.broadleafcommerce.dataimport.asset

Class AssetImportProcessor

java.lang.Object

com.broadleafcommerce.dataimport.asset.AssetImportProcessor

All Implemented Interfaces:

FileImportProcessor

@Component(value="blAssetImportProcessor")
public class AssetImportProcessor
extends Object
implements FileImportProcessor

Handles the upload of a zip file full of static assets and optionally creates folders for them.

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	allowedFileExtensions
static long	BASE_FOLDER_ID
static String[]	EXCLUDED_FILE_NAMES
static FilenameFilter	EXCLUDED_FILE_NAMES_FILTER
protected org.broadleafcommerce.common.file.service.BroadleafFileService	fileService
protected AssetFolderCreator	folderCreator
protected com.broadleafcommerce.process.manager.ProcessStateManager	processStateManager
protected org.broadleafcommerce.cms.file.service.StaticAssetService	staticAssetService
protected org.broadleafcommerce.cms.file.service.StaticAssetStorageService	staticAssetStorageService

Constructor Summary

Constructors

Constructor and Description
AssetImportProcessor()

Method Summary

Modifier and Type	Method and Description
int	calculateTotalRecords(File uploadedFile) Given an InputStream, the implementation should calculate the total number of records to be processed.
protected int	calculateTotalRecordsHelper(File[] files)
boolean	canHandle(File uploadedFile, ImportSpecification importSpecification, ImportType importType) Whether or not this can handle the given input according to the ImportSpecification
protected FilenameFilter	getExcludedFilenamesFilter()
protected long	importAssets(File[] files, Long processId, String basePath, Long baseFolderId)
void	processFile(File uploadedFile, Long processId, ImportContext context) This is designed to process and parse out a given uploadedFile and persist the records to the database.
protected File	unzipFile(File uploaded) Unzips a file and returns a file object that represents the root directory that everything was unzipped to

Methods inherited from class java.lang.Object

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

Field Detail

allowedFileExtensions

@Value(value="${import.server.uploadable.file.allowed.extension}")
protected String allowedFileExtensions

EXCLUDED_FILE_NAMES

public static final String[] EXCLUDED_FILE_NAMES

BASE_FOLDER_ID

public static final long BASE_FOLDER_ID

See Also:

Constant Field Values

EXCLUDED_FILE_NAMES_FILTER

public static final FilenameFilter EXCLUDED_FILE_NAMES_FILTER

fileService

protected org.broadleafcommerce.common.file.service.BroadleafFileService fileService

staticAssetService

protected org.broadleafcommerce.cms.file.service.StaticAssetService staticAssetService

staticAssetStorageService

protected org.broadleafcommerce.cms.file.service.StaticAssetStorageService staticAssetStorageService

processStateManager

protected com.broadleafcommerce.process.manager.ProcessStateManager processStateManager

folderCreator

@Autowired(required=false)
protected AssetFolderCreator folderCreator

Constructor Detail

AssetImportProcessor

public AssetImportProcessor()

Method Detail

canHandle

public boolean canHandle(File uploadedFile,
                         ImportSpecification importSpecification,
                         ImportType importType)

Description copied from interface: FileImportProcessor

Whether or not this can handle the given input according to the ImportSpecification

Specified by:

canHandle in interface FileImportProcessor

Parameters:

uploadedFile - the file that was uploaded by the user

importSpecification - the metadata about uploadedFile in order to determine if it should be processed

Returns:

true if this can handle the given uploadedFile and importSpecification, false otherwise

calculateTotalRecords

public int calculateTotalRecords(File uploadedFile)
                          throws ImportException

Description copied from interface: FileImportProcessor

Given an InputStream, the implementation should calculate the total number of records to be processed.

Specified by:

calculateTotalRecords in interface FileImportProcessor

Returns:

the number of records that will be processed

Throws:

ImportException - if there was a problem in processing the uploadedFile

calculateTotalRecordsHelper

protected int calculateTotalRecordsHelper(File[] files)

processFile

public void processFile(File uploadedFile,
                        Long processId,
                        ImportContext context)
                 throws ImportException

Description copied from interface: FileImportProcessor

This is designed to process and parse out a given uploadedFile and persist the records to the database.

Specified by:

processFile in interface FileImportProcessor

Parameters:

uploadedFile - the original file that was uploaded by the user

Throws:

ImportException - if there was a problem in processing the inputStream

unzipFile

protected File unzipFile(File uploaded)
                  throws net.lingala.zip4j.exception.ZipException,
                         ImportException

Unzips a file and returns a file object that represents the root directory that everything was unzipped to

Parameters:

uploaded -

Returns:

Throws:

net.lingala.zip4j.exception.ZipException

ImportException

importAssets

protected long importAssets(File[] files,
                            Long processId,
                            String basePath,
                            Long baseFolderId)
                     throws FileNotFoundException,
                            IOException

Throws:

FileNotFoundException

IOException

getExcludedFilenamesFilter

protected FilenameFilter getExcludedFilenamesFilter()