com.broadleafcommerce.dataimport.service

Class ImportServiceImpl

java.lang.Object

com.broadleafcommerce.dataimport.service.ImportServiceImpl

All Implemented Interfaces:

ImportService

@Service(value="blImportService")
public class ImportServiceImpl
extends Object
implements ImportService

An Import service to facilitate in determining how to process a given input file. A list of FileImportProcessors can be injected and used. If a registered processor can handle a given ImportSpecification and the passed in InputStream is valid (e.g. a valid CSV file) it will go ahead and process the file. The processing is handled by the Scheduled Jobs and Events framework and will issue an event to be processed immediately.

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.file.service.BroadleafFileService	broadleafFileService
protected int	fileBufferSize
protected long	maxUploadableFileSize
protected com.broadleafcommerce.process.manager.ProcessActionManager	processActionManager
protected com.broadleafcommerce.process.manager.ProcessRegistrationManager	processRegistrationManager
protected com.broadleafcommerce.process.service.ProcessService	processService
protected com.broadleafcommerce.process.manager.ProcessStateManager	processStateManager
protected List<FileImportProcessor>	registeredProcessors

Constructor Summary

Constructors

Constructor and Description
ImportServiceImpl()

Method Summary

Modifier and Type	Method and Description
List<FileImportProcessor>	getRegisteredProcessors()
protected void	populateProcessContext(Map<String,String> processParameters, ImportScheduleDefinition scheduleDefinition, Long adminUserId) Saves off various parts of the BroadleafRequestContext so that the job consumer can re-initialize things like timezone, locale and admin user security to properly save process the import in the background thread
com.broadleafcommerce.process.domain.Process	scheduleImport(InputStream input, ImportScheduleDefinition def) Schedules an import to be processed as a background event to be picked up via the ImportProcessExecutor.
com.broadleafcommerce.process.domain.Process	scheduleImport(InputStream input, ImportScheduleDefinition def, Map<String,String> additionalEventDetails)
void	setRegisteredProcessors(List<FileImportProcessor> registeredProcessors)

Methods inherited from class java.lang.Object

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

Field Detail

maxUploadableFileSize

@Value(value="${import.server.max.uploadable.file.size}")
protected long maxUploadableFileSize

fileBufferSize

@Value(value="${import.server.file.buffer.size}")
protected int fileBufferSize

broadleafFileService

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

processService

protected com.broadleafcommerce.process.service.ProcessService processService

processRegistrationManager

protected com.broadleafcommerce.process.manager.ProcessRegistrationManager processRegistrationManager

processActionManager

protected com.broadleafcommerce.process.manager.ProcessActionManager processActionManager

processStateManager

protected com.broadleafcommerce.process.manager.ProcessStateManager processStateManager

registeredProcessors

protected List<FileImportProcessor> registeredProcessors

Constructor Detail

ImportServiceImpl

public ImportServiceImpl()

Method Detail

scheduleImport

public com.broadleafcommerce.process.domain.Process scheduleImport(InputStream input,
                                                                   ImportScheduleDefinition def)
                                                            throws ImportException,
                                                                   IOException

Schedules an import to be processed as a background event to be picked up via the ImportProcessExecutor. This will first take the given input and save it off into a file. Once the file has been saved to the persistent file store via BroadleafFileService the import event is scheduled and a handle to the Process is returned that can be used to poll.

Specified by:

scheduleImport in interface ImportService

Parameters:

input - stream-based input of the data to import

def - various toggles for how to process the given input

Throws:

ImportException - if ther was a problem in the import

IOException - if there was a problem reading or processing the given file, or if the file exceeds import.server.max.uploadable.file.size

See Also:

FileImportProcessor}

scheduleImport

public com.broadleafcommerce.process.domain.Process scheduleImport(InputStream input,
                                                                   ImportScheduleDefinition def,
                                                                   Map<String,String> additionalEventDetails)
                                                            throws ImportException,
                                                                   IOException

Specified by:

scheduleImport in interface ImportService

Throws:

ImportException

IOException

getRegisteredProcessors

public List<FileImportProcessor> getRegisteredProcessors()

setRegisteredProcessors

public void setRegisteredProcessors(List<FileImportProcessor> registeredProcessors)

populateProcessContext

protected void populateProcessContext(Map<String,String> processParameters,
                                      ImportScheduleDefinition scheduleDefinition,
                                      Long adminUserId)

Saves off various parts of the BroadleafRequestContext so that the job consumer can re-initialize things like timezone, locale and admin user security to properly save process the import in the background thread