Package com.broadleafcommerce.enterprise.workflow.admin.service.behavior.simple

Class SimpleStateManagerImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.service.behavior.simple.SimpleStateManagerImpl

All Implemented Interfaces:

SimpleStateManager

@Service("blSimpleStateManager")
public class SimpleStateManagerImpl
extends Object
implements SimpleStateManager

Author:

Jeff Fischer

See Also:

• SimpleStateManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.enterprise.workflow.admin.service.behavior.simple.SimpleStateManager

SimpleStateManager.DetailGroup, SimpleStateManager.EventGroup

Field Summary

Fields

Modifier and Type	Field	Description
protected org.broadleafcommerce.openadmin.server.service.AdminEntityService	adminEntityService
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected SimpleChangeDetailDao	changeDetailDao
protected SimpleChangeOverrideDao	changeOverrideDao
protected SimpleCloneDao	cloneDao
protected SimpleCloneDao	cloneManager
protected SimpleTransitionDao	dao
protected org.broadleafcommerce.common.util.dao.DynamicDaoHelper	dynamicDaoHelper
protected jakarta.persistence.EntityManager	em
protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowSandBoxItemServiceExtensionManager	extensionManager
protected SimpleInitializationDao	initializationDao
protected static final org.apache.commons.logging.Log	LOG
protected boolean	mergeChangeSetsOnPromote
protected SimpleTableMetadataDao	metadataDao
protected SimplePropagationDao	propagationDao
protected WorkflowSandBoxItemService	service
protected SimpleTableMetadataDao	simpleTableMetadataDao
protected SimpleSystemEventService	systemEventService
protected SimpleWorkflowDao	workflowDao

Constructor Summary

Constructors

Constructor	Description
SimpleStateManagerImpl()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Map<Long,Map<Long,ChangeDetail>>>	applyFKUpdates(List<List<SimplePropagationDao.LineMember>> catalogLines, List<List<SimplePropagationDao.LineMember>> profileLines, Map<String,List<ChangeDetail>> detailsByTable, Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable)
protected Map<String,SimpleCloneDao.ExistingClones>	applyPropagation(SimpleDeployConfiguration deployConfiguration, List<List<SimplePropagationDao.LineMember>> catalogLines, List<List<SimplePropagationDao.LineMember>> catalogLinesWithSiteCustomizable, List<List<SimplePropagationDao.LineMember>> profileLines, List<List<SimplePropagationDao.LineMember>> profileLinesWithSiteCustomizable, Map<String,List<ChangeDetail>> detailsByTable, Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable, boolean includeEmptyDetails)
protected void	applySiteSandboxPropagation(SimpleDeployConfiguration deployConfiguration, List<List<SimplePropagationDao.LineMember>> catalogLines, Map<String,List<ChangeDetail>> detailsByTable, Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable, Map<String,Map<Long,Map<Long,ChangeDetail>>> detailByCatalogByTargetIdByTable)
protected SimpleCloneDao.CreateSandboxRequest	buildInitializeApprovalStateSandboxRequest(Map.Entry<String,List<Object[]>> changeByTable)
protected void	createAuditWorkflowItem(SimpleDeployConfiguration deployConfiguration)
protected void	createInvalidationInfoIfNecessary(Map<String,List<SimpleSystemEventService.InvalidationInfo>> invalidationInfoMap, Map<Long,List<SimpleSystemEventService.InvalidationInfo>> infoByOriginalId, Map.Entry<String,List<ChangeDetail>> entry, ChangeDetail detail, SimplePropagationDao.LineMember member, SimplePropagationDao.LineMember rootLine)
SimpleDeployConfiguration	deploy(List<Long> workflowIds)	Perform a sandbox deployment operation for a list of ids in batch.
protected Long	findWorkflowItemIdForChangeDetail(Long id, Map<Long,List<Long>> changesByItem)
protected Map<String,List<ChangeDetail>>	getChangeDetailDtoByTable(SimpleInitializeApprovalConfiguration iac)
protected List<ChangeDetail>	getChangeDetailsById(List<Long> oldDetailsIds, List<ChangeDetail> details)
protected SimpleCloneDao.CloneState	getCloneStateForDetail(Map<String,Map<Long,SimpleCloneDao.CloneState>> cloneIdsByTable, ChangeDetail changeDetail)
protected Field	getDeclaredField(String[] parts, Class javaType)
protected SimpleDeployConfiguration	getDeployConfig(List<Long> workflowIds)
protected SimpleInitializeApprovalConfiguration	getInitApprovalConfig(List<SimpleStateManager.EventGroup> events)
protected SimplePromoteConfiguration	getPromoteConfig(List<Long> workflowIds, Long targetSandBox)
protected SimpleRejectConfiguration	getRejectConfig(List<Long> workflowIds)
protected SimpleRevertConfiguration	getRevertConfig(List<Long> workflowIds)
protected boolean	hasChangesInChangeDetail(Map.Entry<String,List<ChangeDetail>> entry)
protected void	identifyWorkflowItemsToIgnore(AtomicReference<SimplePromoteConfiguration> config, SimplePromoteConfiguration pc, List<ChangeDetail> details, Map<String,Map<Long,SimpleCloneDao.CloneState>> cloneIdsByTable, Set<Long> workflowIdToIgnore)
void	initializeApprovalState(List<SimpleStateManager.EventGroup> events)	Establish a completely realized approval sandbox state for a batch of changes
protected void	invalidateCacheForDeploy(SimpleDeployConfiguration deployConfiguration, Map<String,List<ChangeDetail>> detailsByTable)
protected void	invalidateCacheForPropagation(SimpleDeployConfiguration deployConfiguration, Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable, List<List<SimplePropagationDao.LineMember>> catalogLinesWithSiteCustomizable, List<List<SimplePropagationDao.LineMember>> profileLinesWithSiteCustomizable)
protected void	invalidateCacheForTransition(Map<String,List<ChangeDetail>> detailsByTable, Map<Long,Long> targetSandBoxByDetail)
protected void	populateOverriddenProperties(Map<String,List<ChangeDetail>> detailsByTable)
SimplePromoteConfiguration	promote(List<Long> workflowIds, Long targetSandBox, Long eventId, String message, boolean isCritical)	Perform a sandbox promote operation for a list of ids in a batch.
void	propagate(SimpleDeployConfiguration deployConfiguration)	Follwing a deploy, perform a propagation of the same ChangeDetails across profile and catalog inheritance lines.
SimpleRejectConfiguration	reject(List<Long> workflowIds, String msg)	Perform a sandbox reject operation for a list of ids in a batch.
SimpleRevertConfiguration	revert(List<Long> workflowIds)	Perform a sandbox revert operation for a list of ids in a batch.

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final org.apache.commons.logging.Log LOG

dao

protected SimpleTransitionDao dao

initializationDao

protected SimpleInitializationDao initializationDao

changeDetailDao

protected SimpleChangeDetailDao changeDetailDao

workflowDao

protected SimpleWorkflowDao workflowDao

cloneManager

protected SimpleCloneDao cloneManager

service

protected WorkflowSandBoxItemService service

systemEventService

protected SimpleSystemEventService systemEventService

propagationDao

protected SimplePropagationDao propagationDao

changeOverrideDao

protected SimpleChangeOverrideDao changeOverrideDao

cloneDao

protected SimpleCloneDao cloneDao

simpleTableMetadataDao

protected SimpleTableMetadataDao simpleTableMetadataDao

adminEntityService

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

em

protected jakarta.persistence.EntityManager em

metadataDao

protected SimpleTableMetadataDao metadataDao

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

extensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowSandBoxItemServiceExtensionManager extensionManager

mergeChangeSetsOnPromote

@Value("${strategy.simple.merge.on.promote:true}")
protected boolean mergeChangeSetsOnPromote

dynamicDaoHelper

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

Constructor Details

SimpleStateManagerImpl

public SimpleStateManagerImpl()

Method Details

initializeApprovalState

public void initializeApprovalState(List<SimpleStateManager.EventGroup> events)

Description copied from interface: SimpleStateManager

Establish a completely realized approval sandbox state for a batch of changes

Specified by:

initializeApprovalState in interface SimpleStateManager

Parameters:

events - The list of changes grouped by approval state (see SimpleStateManager.EventGroup).

getChangeDetailDtoByTable

protected Map<String,List<ChangeDetail>> getChangeDetailDtoByTable(SimpleInitializeApprovalConfiguration iac)

deploy

public SimpleDeployConfiguration deploy(List<Long> workflowIds)
                                 throws SimpleDeployReplayException

Description copied from interface: SimpleStateManager

Perform a sandbox deployment operation for a list of ids in batch.

Specified by:

deploy in interface SimpleStateManager

Parameters:

workflowIds - The WorkflowSandBoxItemImpl instance ids to deploy

Throws:

SimpleDeployReplayException

propagate

public void propagate(SimpleDeployConfiguration deployConfiguration)
               throws SimpleDeployReplayException

Description copied from interface: SimpleStateManager

Follwing a deploy, perform a propagation of the same ChangeDetails across profile and catalog inheritance lines.

Specified by:

propagate in interface SimpleStateManager

Parameters:

deployConfiguration - The config containing ChangeDetail and workflow information for the deploy

Throws:

SimpleDeployReplayException

createAuditWorkflowItem

protected void createAuditWorkflowItem(SimpleDeployConfiguration deployConfiguration)

populateOverriddenProperties

protected void populateOverriddenProperties(Map<String,List<ChangeDetail>> detailsByTable)
                                     throws ClassNotFoundException,
NoSuchFieldException

Throws:

ClassNotFoundException

NoSuchFieldException

getDeclaredField

protected Field getDeclaredField(String[] parts,
 Class javaType)

promote

public SimplePromoteConfiguration promote(List<Long> workflowIds,
 Long targetSandBox,
 Long eventId,
 String message,
 boolean isCritical)
                                   throws SimplePromoteReplayException

Description copied from interface: SimpleStateManager

Perform a sandbox promote operation for a list of ids in a batch.

Specified by:

promote in interface SimpleStateManager

Parameters:

workflowIds - The WorkflowSandBoxItemImpl instance ids to promote

targetSandBox - The approval sandbox to promote into

eventId - The id of the WorkflowEventImpl representing the grouping of the promoted items

message - An optional message to include to identify the purpose of the promotion

isCritical - Whether or not the changes are considered critical.

Throws:

SimplePromoteReplayException

identifyWorkflowItemsToIgnore

protected void identifyWorkflowItemsToIgnore(AtomicReference<SimplePromoteConfiguration> config,
 SimplePromoteConfiguration pc,
 List<ChangeDetail> details,
 Map<String,Map<Long,SimpleCloneDao.CloneState>> cloneIdsByTable,
 Set<Long> workflowIdToIgnore)

Parameters:

config - atomic reference to SimplePromoteConfiguration

pc - SimplePromoteConfiguration instance containing changesByItem

details - all change details to identify corresponding workflow items

cloneIdsByTable - - cloneIds by table map

workflowIdToIgnore - - collection that will be filled if found workflow items that don't need to be created

getChangeDetailsById

protected List<ChangeDetail> getChangeDetailsById(List<Long> oldDetailsIds,
 List<ChangeDetail> details)

findWorkflowItemIdForChangeDetail

protected Long findWorkflowItemIdForChangeDetail(Long id,
 Map<Long,List<Long>> changesByItem)

getCloneStateForDetail

protected SimpleCloneDao.CloneState getCloneStateForDetail(Map<String,Map<Long,SimpleCloneDao.CloneState>> cloneIdsByTable,
 ChangeDetail changeDetail)

revert

public SimpleRevertConfiguration revert(List<Long> workflowIds)
                                 throws SimpleRevertReplayException

Description copied from interface: SimpleStateManager

Perform a sandbox revert operation for a list of ids in a batch.

Specified by:

revert in interface SimpleStateManager

Parameters:

workflowIds - The WorkflowSandBoxItemImpl instance ids to revert

Throws:

SimpleRevertReplayException

reject

public SimpleRejectConfiguration reject(List<Long> workflowIds,
 String msg)
                                 throws SimpleRejectReplayException

Description copied from interface: SimpleStateManager

Perform a sandbox reject operation for a list of ids in a batch.

Specified by:

reject in interface SimpleStateManager

Parameters:

workflowIds - The WorkflowSandBoxItemImpl instance ids to reject

msg - The message that communicates the reason for the rejection

Throws:

SimpleRejectReplayException

invalidateCacheForDeploy

protected void invalidateCacheForDeploy(SimpleDeployConfiguration deployConfiguration,
 Map<String,List<ChangeDetail>> detailsByTable)

invalidateCacheForTransition

protected void invalidateCacheForTransition(Map<String,List<ChangeDetail>> detailsByTable,
 Map<Long,Long> targetSandBoxByDetail)

invalidateCacheForPropagation

protected void invalidateCacheForPropagation(SimpleDeployConfiguration deployConfiguration,
 Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable,
 List<List<SimplePropagationDao.LineMember>> catalogLinesWithSiteCustomizable,
 List<List<SimplePropagationDao.LineMember>> profileLinesWithSiteCustomizable)

createInvalidationInfoIfNecessary

protected void createInvalidationInfoIfNecessary(Map<String,List<SimpleSystemEventService.InvalidationInfo>> invalidationInfoMap,
 Map<Long,List<SimpleSystemEventService.InvalidationInfo>> infoByOriginalId,
 Map.Entry<String,List<ChangeDetail>> entry,
 ChangeDetail detail,
 SimplePropagationDao.LineMember member,
 SimplePropagationDao.LineMember rootLine)

hasChangesInChangeDetail

protected boolean hasChangesInChangeDetail(Map.Entry<String,List<ChangeDetail>> entry)

applySiteSandboxPropagation

protected void applySiteSandboxPropagation(SimpleDeployConfiguration deployConfiguration,
 List<List<SimplePropagationDao.LineMember>> catalogLines,
 Map<String,List<ChangeDetail>> detailsByTable,
 Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable,
 Map<String,Map<Long,Map<Long,ChangeDetail>>> detailByCatalogByTargetIdByTable)

applyFKUpdates

protected Map<String,Map<Long,Map<Long,ChangeDetail>>> applyFKUpdates(List<List<SimplePropagationDao.LineMember>> catalogLines,
 List<List<SimplePropagationDao.LineMember>> profileLines,
 Map<String,List<ChangeDetail>> detailsByTable,
 Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable)

applyPropagation

protected Map<String,SimpleCloneDao.ExistingClones> applyPropagation(SimpleDeployConfiguration deployConfiguration,
 List<List<SimplePropagationDao.LineMember>> catalogLines,
 List<List<SimplePropagationDao.LineMember>> catalogLinesWithSiteCustomizable,
 List<List<SimplePropagationDao.LineMember>> profileLines,
 List<List<SimplePropagationDao.LineMember>> profileLinesWithSiteCustomizable,
 Map<String,List<ChangeDetail>> detailsByTable,
 Map<String,SimplePropagationDao.ApplyResults> applyResultsByTable,
 boolean includeEmptyDetails)

buildInitializeApprovalStateSandboxRequest

protected SimpleCloneDao.CreateSandboxRequest buildInitializeApprovalStateSandboxRequest(Map.Entry<String,List<Object[]>> changeByTable)

getPromoteConfig

@Lookup("blSimplePromoteConfiguration")
protected SimplePromoteConfiguration getPromoteConfig(List<Long> workflowIds,
 Long targetSandBox)

getDeployConfig

@Lookup("blSimpleDeployConfiguration")
protected SimpleDeployConfiguration getDeployConfig(List<Long> workflowIds)

getRejectConfig

@Lookup("blSimpleRejectConfiguration")
protected SimpleRejectConfiguration getRejectConfig(List<Long> workflowIds)

getRevertConfig

@Lookup("blSimpleRevertConfiguration")
protected SimpleRevertConfiguration getRevertConfig(List<Long> workflowIds)

getInitApprovalConfig

@Lookup("blSimpleInitializeApprovalConfiguration")
protected SimpleInitializeApprovalConfiguration getInitApprovalConfig(List<SimpleStateManager.EventGroup> events)