com.broadleafcommerce.dataimport.service.persistence

Class ImportPersisterImpl

java.lang.Object

com.broadleafcommerce.dataimport.service.persistence.ImportPersisterImpl

All Implemented Interfaces:

LateIdResolver, ImportPersister

Direct Known Subclasses:

ImportOrderPersisterImpl

@Component(value="blImportPersister")
public class ImportPersisterImpl
extends Object
implements ImportPersister, LateIdResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.openadmin.server.service.AdminEntityService	adminEntityService
protected javax.persistence.EntityManager	em
protected DynamicEntityDaoProvider	entityDaoProvider
protected org.springframework.core.env.Environment	environment
protected ExecutorService	exService
protected org.broadleafcommerce.profile.core.extension.PostUpdateCustomerExtensionManager	extensionManager
protected ExternalIdUtil	externalIdUtil
protected HashMap<String,String>	idCache
protected List<RecordPersistencePostProcessor>	postProcessors
protected List<RecordPersistencePreProcessor>	preProcessors
protected com.broadleafcommerce.process.manager.ProcessStateManager	processStateManager
protected org.broadleafcommerce.common.site.service.SiteService	siteService

Fields inherited from interface com.broadleafcommerce.dataimport.service.LateIdResolver

LATE_RESOLUTION_VALUE

Constructor Summary

Constructors

Constructor and Description
ImportPersisterImpl()

Method Summary

Modifier and Type	Method and Description
protected org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse	addRecordRequest(Long processId, RecordParseResult record, org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest request, ImportContext context, boolean transactional)
String	buildLateResolutionKey(String ceilingClass, String externalId) This should be invoked by any of the BroadleafCellProcessors that want to resolve an ID late in the game.
protected List<org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest>	filterSubRequests(org.broadleafcommerce.openadmin.dto.Entity mainRequest, org.broadleafcommerce.openadmin.dto.ClassMetadata mainMetadata, List<org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest> subRequests) Some sub requests should not be imported based on the actual type that is being imported.
protected String	getCatalogColumnName()
protected org.broadleafcommerce.common.site.domain.Catalog	getDefaultCatalog(ImportContext context)
String	getPrimaryKey(String key) Attempts to retrieve the primary key from the cache.
protected String	getPrimaryKeyValue(org.broadleafcommerce.openadmin.dto.Entity entity) Obtains the primary key from the entity within the given entity.
protected void	handleValidationError(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse response)
protected String	parseExternalId(String key)
protected org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse	persistMapSubRequest(Long processId, org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse rootResponse, org.broadleafcommerce.openadmin.dto.ClassMetadata mainMetadata, RecordParseResult record, org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest subRequest, ImportContext context)
List<org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse>	persistRecords(List<RecordParseResult> records, ImportContext context, Long processId) Transactionally persists a batch of records into the database If you are invoking this you need to handle validation problems that could occur within each PersistenceResponse result.
protected void	populateLateIds(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest request)
void	populatePrimaryKey(String key, String primaryKey) Populates the cache with a primary key
protected org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse	processEntityAdd(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest request, boolean transactional, org.broadleafcommerce.common.site.domain.Site site, org.broadleafcommerce.common.site.domain.Catalog catalog) This method is responsible for making a callout to the AdminEntityService to process the add request.
void	setAdminEntityService(org.broadleafcommerce.openadmin.server.service.AdminEntityService adminEntityService)

Methods inherited from class java.lang.Object

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

Field Detail

idCache

protected HashMap<String,String> idCache

adminEntityService

protected org.broadleafcommerce.openadmin.server.service.AdminEntityService adminEntityService

externalIdUtil

protected ExternalIdUtil externalIdUtil

processStateManager

protected com.broadleafcommerce.process.manager.ProcessStateManager processStateManager

entityDaoProvider

protected DynamicEntityDaoProvider entityDaoProvider

environment

protected org.springframework.core.env.Environment environment

siteService

protected org.broadleafcommerce.common.site.service.SiteService siteService

preProcessors

@Autowired(required=false)
protected List<RecordPersistencePreProcessor> preProcessors

postProcessors

@Autowired(required=false)
protected List<RecordPersistencePostProcessor> postProcessors

em

protected javax.persistence.EntityManager em

extensionManager

protected org.broadleafcommerce.profile.core.extension.PostUpdateCustomerExtensionManager extensionManager

exService

protected ExecutorService exService

Constructor Detail

ImportPersisterImpl

public ImportPersisterImpl()

Method Detail

setAdminEntityService

@Autowired
public void setAdminEntityService(@Qualifier(value="blAdminEntityService")
                                             org.broadleafcommerce.openadmin.server.service.AdminEntityService adminEntityService)

persistRecords

@Transactional(value="blTransactionManager")
public List<org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse> persistRecords(List<RecordParseResult> records,
                                                                                                                                                        ImportContext context,
                                                                                                                                                        Long processId)
                                                                                                                                                 throws org.broadleafcommerce.common.exception.ServiceException

Transactionally persists a batch of records into the database If you are invoking this you need to handle validation problems that could occur within each PersistenceResponse result.

Specified by:

persistRecords in interface ImportPersister

Parameters:

records - the batch of records to transactionally persist into the database

Throws:

org.broadleafcommerce.common.exception.ServiceException - if there were any problems as a result of persisting the records

addRecordRequest

protected org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse addRecordRequest(Long processId,
                                                                                                          RecordParseResult record,
                                                                                                          org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest request,
                                                                                                          ImportContext context,
                                                                                                          boolean transactional)
                                                                                                   throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException

processEntityAdd

protected org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse processEntityAdd(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest request,
                                                                                                          boolean transactional,
                                                                                                          org.broadleafcommerce.common.site.domain.Site site,
                                                                                                          org.broadleafcommerce.common.site.domain.Catalog catalog)
                                                                                                   throws org.broadleafcommerce.common.exception.ServiceException

This method is responsible for making a callout to the AdminEntityService to process the add request.

Parameters:

request -

transactional -

site -

catalog -

Returns:

Throws:

org.broadleafcommerce.common.exception.ServiceException

filterSubRequests

protected List<org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest> filterSubRequests(org.broadleafcommerce.openadmin.dto.Entity mainRequest,
                                                                                                          org.broadleafcommerce.openadmin.dto.ClassMetadata mainMetadata,
                                                                                                          List<org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest> subRequests)

Some sub requests should not be imported based on the actual type that is being imported. While the importing class could still be something like Product, the actual mainRequest.getType() could be a Sku. Some of the foreign key references that might be hooked up when importing a product (like product attributes) should not be done when importing a Sku.

This default behavior ensures that the mainRequest.getType()[0] is assignable from each sub request's getForeignKey().getForeignKeyClass() (if it has one).

Parameters:

mainRequest - the parent entity that has already been inserted

subRequests - the sub requests right before they are persisted

Returns:

a new list that represents items from subRequests that should actually be persisted.

handleValidationError

protected void handleValidationError(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse response)

persistMapSubRequest

protected org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse persistMapSubRequest(Long processId,
                                                                                                              org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse rootResponse,
                                                                                                              org.broadleafcommerce.openadmin.dto.ClassMetadata mainMetadata,
                                                                                                              RecordParseResult record,
                                                                                                              org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest subRequest,
                                                                                                              ImportContext context)
                                                                                                       throws org.broadleafcommerce.common.exception.ServiceException,
                                                                                                              LateIdResolutionException

Parameters:

rootResponse - the original parent response

mainMetadata - the metadata for the parent request

subRequest - the sub request to persist

Throws:

org.broadleafcommerce.common.exception.ServiceException

LateIdResolutionException

getPrimaryKeyValue

protected String getPrimaryKeyValue(org.broadleafcommerce.openadmin.dto.Entity entity)

Obtains the primary key from the entity within the given entity. This is slightly better than just looking at the id property because it's not hardcoded to do that; it actually inspects the metadata of the entity. Returns null if the primary key property is not found on the given entity or the primary key itself is null

Parameters:

entity - an entity to obtain the primary key from. Entity.getType()[0] must not be null

Returns:

populateLateIds

protected void populateLateIds(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest request)
                        throws LateIdResolutionException

Throws:

LateIdResolutionException

populatePrimaryKey

public void populatePrimaryKey(String key,
                               String primaryKey)

Description copied from interface: LateIdResolver

Populates the cache with a primary key

Specified by:

populatePrimaryKey in interface LateIdResolver

Parameters:

key - a valid key built from LateIdResolver.buildLateResolutionKey(String, String)

primaryKey - the primary key to put in the map

getPrimaryKey

public String getPrimaryKey(String key)

Description copied from interface: LateIdResolver

Attempts to retrieve the primary key from the cache. This will return null if none exists

Specified by:

getPrimaryKey in interface LateIdResolver

Parameters:

key - a valid key built from LateIdResolver.buildLateResolutionKey(String, String)

Returns:

the primary key that was inserted by LateIdResolver.populatePrimaryKey(String, String) or null if none exists

buildLateResolutionKey

public String buildLateResolutionKey(String ceilingClass,
                                     String externalId)

Description copied from interface: LateIdResolver

This should be invoked by any of the BroadleafCellProcessors that want to resolve an ID late in the game. This will automatically build something that takes the ceilingClass, externalId and LateIdResolver.LATE_RESOLUTION_VALUE to build a placeholder key

Specified by:

buildLateResolutionKey in interface LateIdResolver

Parameters:

ceilingClass - the class that the primary key should come from

externalId - the external ID that should uniquely identify the given ceilingClass

Returns:

the key that should be used in place of the actual Broadleaf primary key

parseExternalId

protected String parseExternalId(String key)

getCatalogColumnName

protected String getCatalogColumnName()

getDefaultCatalog

protected org.broadleafcommerce.common.site.domain.Catalog getDefaultCatalog(ImportContext context)