Package com.broadleafcommerce.enterprise.workflow.dao.simple

Class SimpleWorkflowDaoImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.dao.simple.SimpleWorkflowDaoImpl

All Implemented Interfaces:

SimpleWorkflowDao

@Repository("blSimpleWorkflowDao")
public class SimpleWorkflowDaoImpl
extends Object
implements SimpleWorkflowDao

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.enterprise.workflow.dao.simple.SimpleWorkflowDao

SimpleWorkflowDao.LeafWorkflowState, SimpleWorkflowDao.TransitionableCompositeKey, SimpleWorkflowDao.UserItemCompositeKey

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManager	em
protected boolean	enabled
protected BasicIdGeneratorService	idGen
protected SimpleTableMetadataDao	simpleTableMetadataDao
protected com.broadleafcommerce.jobsevents.service.DatabaseSystemEventNode	systemEventNode
protected PlatformJDBCUtil	util

Constructor Summary

Constructors

Constructor	Description
SimpleWorkflowDaoImpl()

Method Summary

Modifier and Type	Method	Description
Map<Long,Long>	advanceWorkflowItems(List<Long> workflowSandboxItemIds, Long targetSandBox)	Archive spent WorkflowSandBoxItem instances and create new ones at the target sandbox.
void	archiveWorkflowItems(List<Long> workflowIds, List<Long> entityItemIds)	Archive a list of WorkflowSandBoxItem and WorkflowEvent instances.
void	associateWorkflowItemsToEvents(List<Long> workflowSandboxItemIds, Long eventId, List<Long> siteIds)	Add WorkflowEventWorkflowItemXref relationships between WorkflowEvent and WorkflowSandBoxItem.
void	clearLinkedEntityItems(List<Long> ids)	Archive EntityItem instances based on a list of EntityItem ids.
void	completeUsedWorkflowEvents(Set<Long> eventIds)	Archive exhausted WorkflowEvent instances.
void	completeUsedWorkflowItems(List<Long> workflowSandboxItemIds)	Archive exhausted WorkflowSandBoxItem instances.
protected PreparedQuery	createdActiveUserItemRejectStatement(Connection connection)
protected PreparedQuery	createEventToItemAssociationStatement(Connection connection)
protected PreparedStatement	createFetchEventStatusStatement(Connection connection, Set<Long> eventIds)
protected jakarta.persistence.TypedQuery<jakarta.persistence.Tuple>	createFindAllChangesQuery()
protected jakarta.persistence.TypedQuery<jakarta.persistence.Tuple>	createFindByWorkflowIdsQuery()
protected jakarta.persistence.TypedQuery<jakarta.persistence.Tuple>	createFindDeployReadyByWorkflowIdsQuery()
Map<String,Long>	createInheritedSandboxWorkflowItems(Set<String> workflowSandboxItemIds, List<SimpleWorkflowDao.LeafWorkflowState> leafWorkflowStates)	Establish WorkflowSandBoxItem instances for items propagated into draft import sandboxes at the standard site level resulting from propagation.
protected String	createOriginalEntityItemFetchStatement(List<Long> deployWorkflowIds)
protected PreparedStatement	createSandboxPropagationWorkflowItemStatement(Connection connection)
protected PreparedQuery	createWorkflowEventDeployRestingStatement(Connection connection)
protected PreparedQuery	createWorkflowEventFailureStatement(Connection connection)
protected PreparedQuery	createWorkflowEventPromotionRestingStatement(Connection connection)
protected PreparedStatement	createWorkflowItemAdvanceStatement(Connection connection)
protected PreparedQuery	createWorkflowItemCompletionStatement(Connection connection)
protected PreparedQuery	createWorkflowItemErrorAddStatement(Connection connection)
protected PreparedQuery	createWorkflowItemFailureStatement(Connection connection)
void	establishEventAtRest(Long eventId, String message, boolean isCritical)	Update WorkflowEvent status to completion.
void	establishEventCompletion(List<Long> eventIds)	Complete and archive a WorkflowEvent.
void	establishRejectForActiveUserItems(List<Long> workflowIds, String msg)	Update the rejection message on user WorkflowSandBoxItem instances on rejection when there is already an active user sandbox record.
WorkflowSandBoxItem	findApprovalItemByExample(WorkflowSandBoxItem example)
Map<Long,String>	getActiveUserItems(List<SimpleWorkflowDao.UserItemCompositeKey> keys)	Given WorkflowSandBoxItem.getGroupDescription() and sandbox information, determine if there is an active user sandbox record for one or more entities.
List<SimpleTransitionDao.ChangePackage>	getAllTransitionablesByKey(List<SimpleWorkflowDao.TransitionableCompositeKey> keys)	Given entity and sandbox information, find all SimpleTransitionDao.ChangePackage.
List<SimpleTransitionDao.ChangePackage>	getDeployTransitionable(List<Long> workflowIds)	For a given list of WorkflowSandBoxItem ids, retrieve a list of SimpleTransitionDao.ChangePackage instances that describe all the components necessary to determine and execute a sandbox deploy transition using a simple strategy.
List<Long>	getLinkedEntityItems(List<Long> workflowIds)	Find any EntityItem ids related to the passed WorkflowSandBoxItem ids.
Map<Long,Integer>	getNumberOfInProgressItemsByEvent(Set<Long> events)	Get a count of in progress WorkflowSandboxItems for a list of events
Map<Long,List<EntityItem>>	getOriginalEntityItems(List<Long> deployWorkflowIds)	Given a list of deploying WorkflowSandboxItem ids, find the EntityItem instances associated with the originating user changes.
List<SimpleTransitionDao.ChangePackage>	getPromotionTransitionable(List<Long> workflowIds)	For a given list of WorkflowSandBoxItem ids, retrieve a list of SimpleTransitionDao.ChangePackage instances that describe all the components necessary to determine and execute a sandbox promotion transition using a simple strategy.
void	invalidateWorkflowEvents(List<Long> ids)	Invalidate L2 cache for several WorkflowEvents
void	invalidateWorkflowSandboxItems(List<Long> ids)	Invalidate L2 cache for several WorkflowSandboxItems
List<Long>	qualifiedWorkflowIds(List<Long> workflowIds)	Determine what portion (if any) of a list of WorkflowSandBoxItem primary key values relate to state that already leverages ChangeDetail state awareness, and should therefore utilize a "Simple" strategy approach for sandbox transitions.
Map<Long,Long>	reverseTransitionWorkflowItems(List<Long> workflowSandBoxItemIds, Map<Long,Long> targetSandBoxByItem, String msg)	Move WorkflowSandBoxItem backward, rather than advancing.
void	setupFailedEventItems(List<Long> eventIds)	Establish failure state for several events
void	setupFailedWorkflowItems(String correlationId, Throwable exception, Throwable rootCause, List<Long> items)	Mark WorkflowSandBoxItem instances that failed replay

Methods inherited from class java.lang.Object

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

Field Details

em

protected jakarta.persistence.EntityManager em

simpleTableMetadataDao

protected SimpleTableMetadataDao simpleTableMetadataDao

systemEventNode

protected com.broadleafcommerce.jobsevents.service.DatabaseSystemEventNode systemEventNode

idGen

protected BasicIdGeneratorService idGen

util

protected PlatformJDBCUtil util

enabled

@Value("${sandbox.lifecycle.strategy.simple.enabled:true}")
protected boolean enabled

Constructor Details

SimpleWorkflowDaoImpl

public SimpleWorkflowDaoImpl()

Method Details

archiveWorkflowItems

public void archiveWorkflowItems(List<Long> workflowIds,
 List<Long> entityItemIds)

Description copied from interface: SimpleWorkflowDao

Archive a list of WorkflowSandBoxItem and WorkflowEvent instances.

Specified by:

archiveWorkflowItems in interface SimpleWorkflowDao

Parameters:

workflowIds - The ids for the WorkflowSandBoxItem entities that should be archived

entityItemIds - The ids for the WorkflowEvent entities that should be archived

getLinkedEntityItems

public List<Long> getLinkedEntityItems(List<Long> workflowIds)

Description copied from interface: SimpleWorkflowDao

Find any EntityItem ids related to the passed WorkflowSandBoxItem ids.

Specified by:

getLinkedEntityItems in interface SimpleWorkflowDao

Parameters:

workflowIds - The WorkflowSandBoxItem ids to check

Returns:

Any related EntityItem ids

getOriginalEntityItems

public Map<Long,List<EntityItem>> getOriginalEntityItems(List<Long> deployWorkflowIds)

Description copied from interface: SimpleWorkflowDao

Given a list of deploying WorkflowSandboxItem ids, find the EntityItem instances associated with the originating user changes.

Specified by:

getOriginalEntityItems in interface SimpleWorkflowDao

Parameters:

deployWorkflowIds - List of deploying WorkflowSandboxItem ids

Returns:

EntityItem instances associated with the originating user changes

getAllTransitionablesByKey

public List<SimpleTransitionDao.ChangePackage> getAllTransitionablesByKey(List<SimpleWorkflowDao.TransitionableCompositeKey> keys)

Description copied from interface: SimpleWorkflowDao

Given entity and sandbox information, find all SimpleTransitionDao.ChangePackage. This may span multiple authors contributing changes to the same entity.

Specified by:

getAllTransitionablesByKey in interface SimpleWorkflowDao

Parameters:

keys - Entity and sandbox information.

Returns:

The list of SimpleTransitionDao.ChangePackage instances.

getActiveUserItems

public Map<Long,String> getActiveUserItems(List<SimpleWorkflowDao.UserItemCompositeKey> keys)

Description copied from interface: SimpleWorkflowDao

Given WorkflowSandBoxItem.getGroupDescription() and sandbox information, determine if there is an active user sandbox record for one or more entities.

Specified by:

getActiveUserItems in interface SimpleWorkflowDao

Parameters:

keys - The list of WorkflowSandBoxItem.getGroupDescription() and sandbox information to test for active user state

Returns:

A map of WorkflowSandBoxItem.getDescription() by WorkflowSandBoxItem.getId() denoting WorkflowSandBoxItem instances related to active user sandbox state.

findApprovalItemByExample

public WorkflowSandBoxItem findApprovalItemByExample(WorkflowSandBoxItem example)

Specified by:

findApprovalItemByExample in interface SimpleWorkflowDao

qualifiedWorkflowIds

public List<Long> qualifiedWorkflowIds(List<Long> workflowIds)

Description copied from interface: SimpleWorkflowDao

Determine what portion (if any) of a list of WorkflowSandBoxItem primary key values relate to state that already leverages ChangeDetail state awareness, and should therefore utilize a "Simple" strategy approach for sandbox transitions.

Specified by:

qualifiedWorkflowIds in interface SimpleWorkflowDao

Parameters:

workflowIds - The primary keys of the relevant WorkflowSandBoxItem instances.

Returns:

The portion of the passed ids that should utilize a simple strategy.

getPromotionTransitionable

public List<SimpleTransitionDao.ChangePackage> getPromotionTransitionable(List<Long> workflowIds)

Description copied from interface: SimpleWorkflowDao

For a given list of WorkflowSandBoxItem ids, retrieve a list of SimpleTransitionDao.ChangePackage instances that describe all the components necessary to determine and execute a sandbox promotion transition using a simple strategy.

Specified by:

getPromotionTransitionable in interface SimpleWorkflowDao

Parameters:

workflowIds - The list of WorkflowSandBoxItem ids for which complete transition information should be retrieved.

Returns:

The list of transitionable information suitable for informing a promotion transition.

getDeployTransitionable

public List<SimpleTransitionDao.ChangePackage> getDeployTransitionable(List<Long> workflowIds)

Description copied from interface: SimpleWorkflowDao

For a given list of WorkflowSandBoxItem ids, retrieve a list of SimpleTransitionDao.ChangePackage instances that describe all the components necessary to determine and execute a sandbox deploy transition using a simple strategy.

Specified by:

getDeployTransitionable in interface SimpleWorkflowDao

Parameters:

workflowIds - The list of WorkflowSandBoxItem ids for which complete transition information should be retrieved.

Returns:

The list of transitionable information suitable for informing a deploy transition.

createInheritedSandboxWorkflowItems

public Map<String,Long> createInheritedSandboxWorkflowItems(Set<String> workflowSandboxItemIds,
 List<SimpleWorkflowDao.LeafWorkflowState> leafWorkflowStates)

Description copied from interface: SimpleWorkflowDao

Establish WorkflowSandBoxItem instances for items propagated into draft import sandboxes at the standard site level resulting from propagation.

Specified by:

createInheritedSandboxWorkflowItems in interface SimpleWorkflowDao

Parameters:

workflowSandboxItemIds - The ids for the deploying WorkflowSandboxItems

leafWorkflowStates - Descriptor information for the standard site workflow state

Returns:

The new WorkflowSandboxItem id by the deploying WorkflowSandboxItem id

completeUsedWorkflowItems

public void completeUsedWorkflowItems(List<Long> workflowSandboxItemIds)

Description copied from interface: SimpleWorkflowDao

Archive exhausted WorkflowSandBoxItem instances.

Specified by:

completeUsedWorkflowItems in interface SimpleWorkflowDao

Parameters:

workflowSandboxItemIds - The WorkflowSandBoxItem ids to update.

invalidateWorkflowSandboxItems

public void invalidateWorkflowSandboxItems(List<Long> ids)

Description copied from interface: SimpleWorkflowDao

Invalidate L2 cache for several WorkflowSandboxItems

Specified by:

invalidateWorkflowSandboxItems in interface SimpleWorkflowDao

Parameters:

ids - The ids of the items to invalidate in cache

invalidateWorkflowEvents

public void invalidateWorkflowEvents(List<Long> ids)

Description copied from interface: SimpleWorkflowDao

Invalidate L2 cache for several WorkflowEvents

Specified by:

invalidateWorkflowEvents in interface SimpleWorkflowDao

Parameters:

ids - The ids of the workflow events to invalidate in cache

clearLinkedEntityItems

public void clearLinkedEntityItems(List<Long> ids)

Description copied from interface: SimpleWorkflowDao

Archive EntityItem instances based on a list of EntityItem ids.

Specified by:

clearLinkedEntityItems in interface SimpleWorkflowDao

Parameters:

ids - The list of ids for the EntityItem instances to archive

establishEventAtRest

public void establishEventAtRest(Long eventId,
 String message,
 boolean isCritical)

Description copied from interface: SimpleWorkflowDao

Update WorkflowEvent status to completion.

Specified by:

establishEventAtRest in interface SimpleWorkflowDao

Parameters:

eventId - The id of the WorkflowEvent to update

message - The message to place on the event

isCritical - Mark whether or not the event is critical

establishEventCompletion

public void establishEventCompletion(List<Long> eventIds)

Description copied from interface: SimpleWorkflowDao

Complete and archive a WorkflowEvent.

Specified by:

establishEventCompletion in interface SimpleWorkflowDao

Parameters:

eventIds - The ids of the WorkflowEvents to update.

getNumberOfInProgressItemsByEvent

public Map<Long,Integer> getNumberOfInProgressItemsByEvent(Set<Long> events)

Description copied from interface: SimpleWorkflowDao

Get a count of in progress WorkflowSandboxItems for a list of events

Specified by:

getNumberOfInProgressItemsByEvent in interface SimpleWorkflowDao

Parameters:

events - The events for which item status should be checked

Returns:

Count of in progress items by WorkflowEvent id

associateWorkflowItemsToEvents

public void associateWorkflowItemsToEvents(List<Long> workflowSandboxItemIds,
 Long eventId,
 List<Long> siteIds)

Description copied from interface: SimpleWorkflowDao

Add WorkflowEventWorkflowItemXref relationships between WorkflowEvent and WorkflowSandBoxItem.

Specified by:

associateWorkflowItemsToEvents in interface SimpleWorkflowDao

Parameters:

workflowSandboxItemIds - The WorkflowSandBoxItem instances to associate to the event.

eventId - The WorkflowEvent instance to associate to the items.

siteIds - The site id values (per item) used during the creation of each item.

advanceWorkflowItems

public Map<Long,Long> advanceWorkflowItems(List<Long> workflowSandboxItemIds,
 Long targetSandBox)

Description copied from interface: SimpleWorkflowDao

Archive spent WorkflowSandBoxItem instances and create new ones at the target sandbox.

Specified by:

advanceWorkflowItems in interface SimpleWorkflowDao

Parameters:

workflowSandboxItemIds - The WorkflowSandBoxItem ids to advance.

targetSandBox - The target sandbox for the advanced items.

Returns:

A map of old WorkflowSandBoxItem id to new WorkflowSandBoxItem id.

reverseTransitionWorkflowItems

public Map<Long,Long> reverseTransitionWorkflowItems(List<Long> workflowSandBoxItemIds,
 Map<Long,Long> targetSandBoxByItem,
 String msg)

Description copied from interface: SimpleWorkflowDao

Move WorkflowSandBoxItem backward, rather than advancing. Usually used during a reject.

Specified by:

reverseTransitionWorkflowItems in interface SimpleWorkflowDao

Parameters:

workflowSandBoxItemIds - The WorkflowSandBoxItem ids to move backward.

targetSandBoxByItem - The target sandbox for the movement.

msg - The message to go with the movement (usually the rejection message).

Returns:

A map of old WorkflowSandBoxItem id to new WorkflowSandBoxItem id.

establishRejectForActiveUserItems

public void establishRejectForActiveUserItems(List<Long> workflowIds,
 String msg)

Description copied from interface: SimpleWorkflowDao

Update the rejection message on user WorkflowSandBoxItem instances on rejection when there is already an active user sandbox record. This would usually occur if a rejection takes place on a change, and the targeted user already has created another change on the same entity prior to the rejection.

Specified by:

establishRejectForActiveUserItems in interface SimpleWorkflowDao

Parameters:

workflowIds - The WorkflowSandBoxItem ids to update.

msg - The message to go with the movement (usually the rejection message).

setupFailedWorkflowItems

public void setupFailedWorkflowItems(String correlationId,
 Throwable exception,
 Throwable rootCause,
 List<Long> items)

Description copied from interface: SimpleWorkflowDao

Mark WorkflowSandBoxItem instances that failed replay

Specified by:

setupFailedWorkflowItems in interface SimpleWorkflowDao

Parameters:

correlationId - Tie this failure to a message in the application logs

exception - The caught exception

rootCause - The root cause exception

items - List of WorkflowSandBoxItem id

setupFailedEventItems

public void setupFailedEventItems(List<Long> eventIds)

Description copied from interface: SimpleWorkflowDao

Establish failure state for several events

Specified by:

setupFailedEventItems in interface SimpleWorkflowDao

Parameters:

eventIds - The failed event ids

completeUsedWorkflowEvents

public void completeUsedWorkflowEvents(Set<Long> eventIds)

Description copied from interface: SimpleWorkflowDao

Archive exhausted WorkflowEvent instances.

Specified by:

completeUsedWorkflowEvents in interface SimpleWorkflowDao

Parameters:

eventIds - The WorkflowEvent ids to update.

createWorkflowItemCompletionStatement

protected PreparedQuery createWorkflowItemCompletionStatement(Connection connection)
                                                       throws SQLException

Throws:

SQLException

createEventToItemAssociationStatement

protected PreparedQuery createEventToItemAssociationStatement(Connection connection)
                                                       throws SQLException

Throws:

SQLException

createWorkflowEventPromotionRestingStatement

protected PreparedQuery createWorkflowEventPromotionRestingStatement(Connection connection)
                                                              throws SQLException

Throws:

SQLException

createFetchEventStatusStatement

protected PreparedStatement createFetchEventStatusStatement(Connection connection,
 Set<Long> eventIds)
                                                     throws SQLException

Throws:

SQLException

createWorkflowEventDeployRestingStatement

protected PreparedQuery createWorkflowEventDeployRestingStatement(Connection connection)
                                                           throws SQLException

Throws:

SQLException

createWorkflowItemFailureStatement

protected PreparedQuery createWorkflowItemFailureStatement(Connection connection)
                                                    throws SQLException

Throws:

SQLException

createWorkflowEventFailureStatement

protected PreparedQuery createWorkflowEventFailureStatement(Connection connection)
                                                     throws SQLException

Throws:

SQLException

createWorkflowItemErrorAddStatement

protected PreparedQuery createWorkflowItemErrorAddStatement(Connection connection)
                                                     throws SQLException

Throws:

SQLException

createdActiveUserItemRejectStatement

protected PreparedQuery createdActiveUserItemRejectStatement(Connection connection)
                                                      throws SQLException

Throws:

SQLException

createWorkflowItemAdvanceStatement

protected PreparedStatement createWorkflowItemAdvanceStatement(Connection connection)
                                                        throws SQLException

Throws:

SQLException

createSandboxPropagationWorkflowItemStatement

protected PreparedStatement createSandboxPropagationWorkflowItemStatement(Connection connection)
                                                                   throws SQLException

Throws:

SQLException

createOriginalEntityItemFetchStatement

protected String createOriginalEntityItemFetchStatement(List<Long> deployWorkflowIds)

createFindAllChangesQuery

protected jakarta.persistence.TypedQuery<jakarta.persistence.Tuple> createFindAllChangesQuery()

createFindByWorkflowIdsQuery

protected jakarta.persistence.TypedQuery<jakarta.persistence.Tuple> createFindByWorkflowIdsQuery()

createFindDeployReadyByWorkflowIdsQuery

protected jakarta.persistence.TypedQuery<jakarta.persistence.Tuple> createFindDeployReadyByWorkflowIdsQuery()