com.broadleafcommerce.enterprise.workflow.admin.clone

Class AbstractCloneProvider

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.clone.AbstractCloneProvider

All Implemented Interfaces:

CloneProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered

Direct Known Subclasses:

DefaultCloneProvider

public abstract class AbstractCloneProvider
extends Object
implements CloneProvider, org.springframework.context.ApplicationContextAware

Author:

Jeff Fischer

See Also:

CloneProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected int	batchSize
protected CloneManager	cloneManager
protected com.broadleafcommerce.enterprise.common.extension.enterprise.AbstractCloneProviderExtensionManager	cloneProviderExtensionManager
protected com.broadleafcommerce.enterprise.common.persistence.filter.FilterStateManager	filterStateManager
protected org.broadleafcommerce.common.util.dao.DynamicDaoHelper	helper
protected Map<String,Map<String,org.hibernate.type.Type>>	typePool
protected EnterpriseWorkflowLogger	workflowLogger
protected WorkflowStateManager	workflowStateManager

Fields inherited from interface com.broadleafcommerce.enterprise.workflow.admin.clone.CloneProvider

CATEGORY, DEFAULT, OFFER, PRODUCT, SKU

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractCloneProvider()

Method Summary

Modifier and Type	Method and Description
boolean	archiveObject(Object start, javax.persistence.EntityManager em) Soft-delete the entity (presumably a production entity).
boolean	archiveObject(Object start, javax.persistence.EntityManager em, boolean forceArchive) Soft-delete the entity (presumably a production entity).
protected abstract boolean	canHandle(Object start, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected <T> T	convertBean(T originalBean, T targetBean, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, org.broadleafcommerce.common.web.BroadleafRequestContext context, boolean forDelete, boolean includeClonePolicy) Copy properties from the original to the target
protected <T> T	convertBean(T originalBean, T targetBean, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, org.broadleafcommerce.common.web.BroadleafRequestContext context, boolean forDelete, boolean includeClonePolicy, Map<Serializable,Object> instanceLibrary, Set<WorkflowCloneLibrary> cloneLibGroup) Copy properties from the original to the target
protected <T> T	convertBean(T originalBean, T targetBean, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, String[] ignoreFields, org.broadleafcommerce.common.web.BroadleafRequestContext context, boolean forDelete, boolean includeClonePolicy) Copy properties from the original to the target
protected <T> T	convertBean(T originalBean, T targetBean, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, String[] ignoreFields, org.broadleafcommerce.common.web.BroadleafRequestContext context, boolean forDelete, boolean includeClonePolicy, Map<Serializable,Object> instanceLibrary, Set<WorkflowCloneLibrary> cloneLibGroup) Copy properties from the original to the target
void	establishCatalogFlag(Object clone) Set the catalog flag for the current site, or 0 if not applicable
protected void	establishCatalogFlag(Object clone, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager) We may be dealing with multitenant, in which case we need to set a catalog flag based on the site to allow an aspect of the enterprise query to work.
int	getBatchSize() When processing adorned target collections during cloning, it is useful to update the collections members in batches in order to not run out of memory for large collection scenarios.
CloneManager	getCloneManager()
protected Field[]	getFields(Class<?> clazz) Get all the fields for a class and its superclasses
protected <T> Map<String,org.hibernate.type.Type>	getFromCache(T originalBean, javax.persistence.EntityManager em, boolean includeId, org.hibernate.type.Type originalType) Retrieve a map of property name to property type
org.broadleafcommerce.common.util.dao.DynamicDaoHelper	getHelper()
protected String	getIdentifier(javax.persistence.EntityManager em, Object test)
protected abstract <T> T	handleClonePolicy(T start, T clone, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, org.broadleafcommerce.common.web.BroadleafRequestContext context, boolean forDelete, boolean includeClonePolicy, Map<Serializable,Object> instanceLibrary, Set<WorkflowCloneLibrary> cloneLibGroup) Handle cloning for collections marked with one of the ClonePolicy annotations.
protected <T> T	performConvert(T originalBean, T targetBean, Field[] fields, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, String[] ignoreFields, org.hibernate.type.Type originalType, Map<Serializable,Object> instanceLibrary, org.broadleafcommerce.common.web.BroadleafRequestContext context, boolean forDelete, boolean includeClonePolicy, Set<WorkflowCloneLibrary> cloneLibGroup) Copy properties from the original bean to the target bean
protected <T> void	performPrepare(T originalBean, Field[] fields, javax.persistence.EntityManager em) Force loading of collections (presumably lazy loaded collections)
protected <T> void	prepareCollections(T originalBean, javax.persistence.EntityManager em) Force loading of collections (presumably lazy loaded collections)
CloneProviderResponse	prepareState(Object start, javax.persistence.EntityManager em, org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager, org.broadleafcommerce.common.web.BroadleafRequestContext context) Initialize the entity, including lazy collections.
boolean	processCascadeSave(Object start, Object target, javax.persistence.EntityManager em) Does nothing by default.
boolean	sandBoxArchiveObject(Object start, javax.persistence.EntityManager em) Does nothing by default.
boolean	sandBoxArchiveProductionObject(Object start, javax.persistence.EntityManager em) Soft-delete the production entity.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBatchSize(int batchSize)
void	setCloneManager(CloneManager cloneManager)
void	setHelper(org.broadleafcommerce.common.util.dao.DynamicDaoHelper helper)
boolean	setupProdAddState(Object start, javax.persistence.EntityManager em)
void	setupSandBoxState(Object clone, Object original, String idProperty, org.broadleafcommerce.common.web.BroadleafRequestContext context, javax.persistence.EntityManager em) Set the various sandbox related fields to their appropriate values
void	setupSandBoxState(Object clone, String idProperty, org.broadleafcommerce.common.web.BroadleafRequestContext context, javax.persistence.EntityManager em) Set the various sandbox related fields to their appropriate values
boolean	unArchiveObject(Object start, javax.persistence.EntityManager em)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.enterprise.workflow.admin.clone.CloneProvider

cloneObject, setupRemoveState, updateNestedCloneReferences

Methods inherited from interface org.springframework.core.Ordered

getOrder

Field Detail

batchSize

protected int batchSize

cloneManager

protected CloneManager cloneManager

typePool

protected Map<String,Map<String,org.hibernate.type.Type>> typePool

helper

protected org.broadleafcommerce.common.util.dao.DynamicDaoHelper helper

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

workflowStateManager

protected WorkflowStateManager workflowStateManager

workflowLogger

@Autowired(required=false)
protected EnterpriseWorkflowLogger workflowLogger

filterStateManager

protected com.broadleafcommerce.enterprise.common.persistence.filter.FilterStateManager filterStateManager

cloneProviderExtensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.AbstractCloneProviderExtensionManager cloneProviderExtensionManager

Constructor Detail

AbstractCloneProvider

public AbstractCloneProvider()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setupSandBoxState

public void setupSandBoxState(Object clone,
                              Object original,
                              String idProperty,
                              org.broadleafcommerce.common.web.BroadleafRequestContext context,
                              javax.persistence.EntityManager em)

Description copied from interface: CloneProvider

Set the various sandbox related fields to their appropriate values

Specified by:

setupSandBoxState in interface CloneProvider

Parameters:

clone - the cloned instance

original - the original instance

idProperty - the primary key property on the bean

context - the broadleaf request context

em - the entity manager

See Also:

SandBoxDiscriminator

establishCatalogFlag

public void establishCatalogFlag(Object clone)
                          throws IllegalAccessException,
                                 InstantiationException

Description copied from interface: CloneProvider

Set the catalog flag for the current site, or 0 if not applicable

Specified by:

establishCatalogFlag in interface CloneProvider

Parameters:

clone - the cloned instance

Throws:

IllegalAccessException

InstantiationException

setupSandBoxState

public void setupSandBoxState(Object clone,
                              String idProperty,
                              org.broadleafcommerce.common.web.BroadleafRequestContext context,
                              javax.persistence.EntityManager em)

Description copied from interface: CloneProvider

Set the various sandbox related fields to their appropriate values

Specified by:

setupSandBoxState in interface CloneProvider

Parameters:

clone - the cloned instance

idProperty - the primary key property on the bean

context - the broadleaf request context

em - the entity manager

See Also:

SandBoxDiscriminator

prepareState

public CloneProviderResponse prepareState(Object start,
                                          javax.persistence.EntityManager em,
                                          org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                                          org.broadleafcommerce.common.web.BroadleafRequestContext context)

Description copied from interface: CloneProvider

Initialize the entity, including lazy collections. Useful as part of rollbacks.

Specified by:

prepareState in interface CloneProvider

Parameters:

start - the instance to prepare

em - the entity manager

fieldManager - the field manager

context - the broadleaf request context

Returns:

response object containing the prepared entity and the status

getBatchSize

public int getBatchSize()

When processing adorned target collections during cloning, it is useful to update the collections members in batches in order to not run out of memory for large collection scenarios. This property defines the size of that batch.

Returns:

the adorned target collection processing batch size

setBatchSize

public void setBatchSize(int batchSize)

Parameters:

batchSize - the batch

See Also:

getBatchSize()

getCloneManager

public CloneManager getCloneManager()

setCloneManager

public void setCloneManager(CloneManager cloneManager)

getHelper

public org.broadleafcommerce.common.util.dao.DynamicDaoHelper getHelper()

setHelper

public void setHelper(org.broadleafcommerce.common.util.dao.DynamicDaoHelper helper)

canHandle

protected abstract boolean canHandle(Object start,
                                     javax.persistence.EntityManager em,
                                     org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                                     org.broadleafcommerce.common.web.BroadleafRequestContext context)

establishCatalogFlag

protected void establishCatalogFlag(Object clone,
                                    org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager)
                             throws IllegalAccessException,
                                    InstantiationException

We may be dealing with multitenant, in which case we need to set a catalog flag based on the site to allow an aspect of the enterprise query to work. Specifically, when looking for shared catalog production records, we need to make sure there are not any production records in my site for that same item. Since this determination is made in a subquery, it does not benefit from the site filters employed by multitenant. We need some flag to select off of that somehow identifies my site for this subquery - hence we've introduced a generic "catalogFlag" concept. The scope of it's usage is limited, but important, nonetheless.

Parameters:

clone - the clone

fieldManager - the field manager

Throws:

IllegalAccessException

InstantiationException

handleClonePolicy

protected abstract <T> T handleClonePolicy(T start,
                                           T clone,
                                           javax.persistence.EntityManager em,
                                           org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                                           org.broadleafcommerce.common.web.BroadleafRequestContext context,
                                           boolean forDelete,
                                           boolean includeClonePolicy,
                                           Map<Serializable,Object> instanceLibrary,
                                           Set<WorkflowCloneLibrary> cloneLibGroup)

Handle cloning for collections marked with one of the ClonePolicy annotations.

Type Parameters:

T - the entity type

Parameters:

start - the original entity

clone - the cloned entity containing collections to clone

em - the entity manager

fieldManager - the field manager

context - the broadleaf request context

forDelete - whether or not this operation is part of a rollback

includeClonePolicy - whether or not marked collections should be processed

instanceLibrary - map that keeps track of field references that have already been processed (avoid repeat clones when an entity has multiple references to the same item)

cloneLibGroup - keeps track of the WorkflowCloneLibrary instances added

Returns:

the processed clone

See Also:

ClonePolicy

convertBean

protected <T> T convertBean(T originalBean,
                            T targetBean,
                            javax.persistence.EntityManager em,
                            org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                            org.broadleafcommerce.common.web.BroadleafRequestContext context,
                            boolean forDelete,
                            boolean includeClonePolicy)

Copy properties from the original to the target

Type Parameters:

T -

Parameters:

originalBean -

targetBean -

em -

fieldManager -

context -

forDelete -

includeClonePolicy -

Returns:

the converted target bean

convertBean

protected <T> T convertBean(T originalBean,
                            T targetBean,
                            javax.persistence.EntityManager em,
                            org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                            org.broadleafcommerce.common.web.BroadleafRequestContext context,
                            boolean forDelete,
                            boolean includeClonePolicy,
                            Map<Serializable,Object> instanceLibrary,
                            Set<WorkflowCloneLibrary> cloneLibGroup)

Copy properties from the original to the target

Type Parameters:

T -

Parameters:

originalBean -

targetBean -

em -

fieldManager -

context -

forDelete -

includeClonePolicy -

instanceLibrary -

cloneLibGroup -

Returns:

the converted target bean

convertBean

protected <T> T convertBean(T originalBean,
                            T targetBean,
                            javax.persistence.EntityManager em,
                            org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                            String[] ignoreFields,
                            org.broadleafcommerce.common.web.BroadleafRequestContext context,
                            boolean forDelete,
                            boolean includeClonePolicy)

Copy properties from the original to the target

Type Parameters:

T -

Parameters:

originalBean -

targetBean -

em -

fieldManager -

ignoreFields -

context -

forDelete -

includeClonePolicy -

Returns:

the converted target bean

convertBean

protected <T> T convertBean(T originalBean,
                            T targetBean,
                            javax.persistence.EntityManager em,
                            org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                            String[] ignoreFields,
                            org.broadleafcommerce.common.web.BroadleafRequestContext context,
                            boolean forDelete,
                            boolean includeClonePolicy,
                            Map<Serializable,Object> instanceLibrary,
                            Set<WorkflowCloneLibrary> cloneLibGroup)

Copy properties from the original to the target

Type Parameters:

T -

Parameters:

originalBean -

targetBean -

em -

fieldManager -

ignoreFields -

context -

forDelete -

includeClonePolicy -

instanceLibrary -

cloneLibGroup -

Returns:

the converted target bean

prepareCollections

protected <T> void prepareCollections(T originalBean,
                                      javax.persistence.EntityManager em)

Force loading of collections (presumably lazy loaded collections)

Type Parameters:

T -

Parameters:

originalBean -

em -

performPrepare

protected <T> void performPrepare(T originalBean,
                                  Field[] fields,
                                  javax.persistence.EntityManager em)
                           throws Exception

Force loading of collections (presumably lazy loaded collections)

Type Parameters:

T -

Parameters:

originalBean -

fields -

em -

Throws:

Exception

performConvert

protected <T> T performConvert(T originalBean,
                               T targetBean,
                               Field[] fields,
                               javax.persistence.EntityManager em,
                               org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager fieldManager,
                               String[] ignoreFields,
                               org.hibernate.type.Type originalType,
                               Map<Serializable,Object> instanceLibrary,
                               org.broadleafcommerce.common.web.BroadleafRequestContext context,
                               boolean forDelete,
                               boolean includeClonePolicy,
                               Set<WorkflowCloneLibrary> cloneLibGroup)
                        throws Exception

Copy properties from the original bean to the target bean

Type Parameters:

T -

Parameters:

originalBean -

targetBean -

fields -

em -

fieldManager -

ignoreFields -

originalType -

instanceLibrary -

context -

forDelete -

includeClonePolicy -

cloneLibGroup -

Returns:

the converted target bean

Throws:

Exception

getIdentifier

protected String getIdentifier(javax.persistence.EntityManager em,
                               Object test)

getFromCache

protected <T> Map<String,org.hibernate.type.Type> getFromCache(T originalBean,
                                                               javax.persistence.EntityManager em,
                                                               boolean includeId,
                                                               org.hibernate.type.Type originalType)

Retrieve a map of property name to property type

Type Parameters:

T -

Parameters:

originalBean - the bean to inspect

em -

includeId - whether or not to include the id property

originalType - the Type of the bean to inspect

Returns:

the cached

getFields

protected Field[] getFields(Class<?> clazz)

Get all the fields for a class and its superclasses

Parameters:

clazz -

Returns:

sandBoxArchiveObject

public boolean sandBoxArchiveObject(Object start,
                                    javax.persistence.EntityManager em)

Does nothing by default. Subclasses should override for specific archive behavior.

Specified by:

sandBoxArchiveObject in interface CloneProvider

Parameters:

start - the sandboxable entity to archive

em - the entity manager

Returns:

See Also:

CloneProvider.sandBoxArchiveObject(Object, javax.persistence.EntityManager)

archiveObject

public boolean archiveObject(Object start,
                             javax.persistence.EntityManager em)

Description copied from interface: CloneProvider

Soft-delete the entity (presumably a production entity). Involves setting the archived state (not sandbox archived) to 'Y' so that the record is no longer included in regular query results. This does not free the entity up for purge and the entity will remain in the datastore as an archived item.

Specified by:

archiveObject in interface CloneProvider

Parameters:

start - the entity instance to archive

em - the entity manager

Returns:

whether or not the entity was archived

archiveObject

public boolean archiveObject(Object start,
                             javax.persistence.EntityManager em,
                             boolean forceArchive)

Description copied from interface: CloneProvider

Soft-delete the entity (presumably a production entity). Involves setting the archived state (not sandbox archived) to 'Y' so that the record is no longer included in regular query results. This does not free the entity up for purge and the entity will remain in the datastore as an archived item.

Specified by:

archiveObject in interface CloneProvider

Parameters:

start - the entity instance to archive

em - the entity manager

forceArchive - ignore any state checks that could preclude the archival

Returns:

whether or not the entity was archived

sandBoxArchiveProductionObject

public boolean sandBoxArchiveProductionObject(Object start,
                                              javax.persistence.EntityManager em)

Description copied from interface: CloneProvider

Soft-delete the production entity. Involves setting the sandbox archived state to 'Y' so that the clone no longer appears in the admin for the sandbox. This frees the entity up for subsequent purge. This method should only be called for cases where it is desirable to allow a production record to be completely deleted from the database. An example case would be a temporary production record created during an entity "add" operation that is no longer required.

Specified by:

sandBoxArchiveProductionObject in interface CloneProvider

Returns:

unArchiveObject

public boolean unArchiveObject(Object start,
                               javax.persistence.EntityManager em)

Specified by:

unArchiveObject in interface CloneProvider

setupProdAddState

public boolean setupProdAddState(Object start,
                                 javax.persistence.EntityManager em)

Specified by:

setupProdAddState in interface CloneProvider

processCascadeSave

public boolean processCascadeSave(Object start,
                                  Object target,
                                  javax.persistence.EntityManager em)

Does nothing by default. Subclasses should override for specific behavior.

Specified by:

processCascadeSave in interface CloneProvider

Parameters:

start -

target -

em -

Returns:

See Also:

SandBoxDiscriminatorImpl.setOriginalRecordId(Long), SandBoxDiscriminatorImpl.setTemplateRecordId(Long)