com.broadleafcommerce.enterprise.workflow.admin.service

Class WorkflowEventServiceImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.service.WorkflowEventServiceImpl

All Implemented Interfaces:

WorkflowEventService

@Service(value="blWorkflowEventService")
public class WorkflowEventServiceImpl
extends Object
implements WorkflowEventService

Author:

Andre Azzolini (apazzolini), Jeff Fischer

See Also:

WorkflowEventService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.openadmin.server.security.remote.SecurityVerifier	adminRemoteSecurityService
protected WorkflowEventDao	dao
protected ExecutionLockUtil	lockUtil
protected com.broadleafcommerce.jobsevents.dao.ProcessManagementDao	processDao
protected org.springframework.context.ApplicationEventPublisher	publisher
protected com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDao	systemEventDao
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil
protected EnterpriseWorkflowLogger	workflowLogger

Constructor Summary

Constructors

Constructor and Description
WorkflowEventServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	archiveWorkflowEventsBySandBoxId(Long sandBoxId) Archive all WorkflowEvents associated to the given SandBox
void	cancelDeployment(WorkflowDeployment deployment) Unschedules the deployment's associated events, deletes the deployment's job and then deletes the deployment itself.
int	completeEvents(List<Long> sandBoxItemIds) Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances that have no un-completed WorkflowSandBoxItem instances and set those events to completed status.
void	delete(WorkflowEvent event) Deletes the specified WorkflowEvent from the database
void	detach(WorkflowDeployment deployment) Detaches the given WorkflowDeployment instance from the entity manager.
List<Long>	findAllDeployingIdsForSandBox(Long sandBoxId) Finds the ids corresponding to WorkflowEvents that are in the specified sandbox and are currently deploying.
List<WorkflowEvent>	findAllForSandBox(Long sandBoxId) Finds all WorkflowEvents that are currently associated with the given sandbox
List<WorkflowDeployment>	findAllFutureDeployments() Finds a list of WorkflowDeployments that are set to deploy at a future time.
List<Long>	findAllIdsForSandBox(Long sandBoxId) Finds the ids corresponding to WorkflowEvents that are in the specified sandbox.
List<Long>	findAllNotDeployedIdsForSandBox(Long sandBoxId) Finds the ids corresponding to WorkflowEvents that are in the specified sandbox and are not yet deployed.
WorkflowEvent	findById(Long id) Finds a given WorkflowEvent by its internal id
List<WorkflowEvent>	findByIds(List<Long> ids) Finds several WorkflowEvents by the given internal ids
List<Long>	findBySandBoxItem(List<Long> sandBoxItemIds) Finds the WorkflowEvents ids that are associated with the given WorkflowSandBoxItem ids
WorkflowDeployment	findDeploymentById(Long id) Finds a WorkflowDeployment instance that corresponds to the given id
WorkflowDeployment	findDeploymentByJob(Long jobId) Finds a WorkflowDeployment instance that corresponds to the given job id
List<String>	findDeploymentIdsForCurrentUser()
List<WorkflowDeployment>	findDeploymentsByEvents(List<Long> events) Finds a list of WorkflowDeployments that are associated to the given list of WorkflowEvent ids.
List<WorkflowEvent>	findEntitiesBySandBoxItem(List<Long> sandBoxItemIds) Finds the WorkflowEvents that are associated with the given WorkflowSandBoxItem ids
com.broadleafcommerce.jobsevents.domain.ScheduledJob	findJobByJobId(Long jobId) Finds the scheduled job associated with the deployment
void	finishDeployment(Long deploymentId) Set the StatusTiming#getDateFinished() on WorkflowDeployment.
WorkflowEvent	logEvent(SandBoxActionType actionType, String eventName, String originalMessage, String eventMessage, org.broadleafcommerce.openadmin.server.security.domain.AdminUser author, org.broadleafcommerce.common.sandbox.domain.SandBox sandBox) Creates a WorkflowEvent that represents the given parameters.
List<Long>	readEventIdsByDeployment(Long deploymentId) Based on the id value from a WorkflowDeployment, find all associated WorkflowEvent.getId() values.
List<Long>	readUnscheduledEventIdsByApprovalStatus(Long sandboxId, boolean isApproved) Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and that are not deployed or scheduled for deployment
List<Long>	readUnscheduledEventIdsByCriticalAndApprovalStatuses(Long sandboxId, boolean isCritical, boolean isApproved) Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and WorkflowEventImpl.isCritical and that are not deployed or scheduled for deployment
WorkflowEvent	refresh(WorkflowEvent event) Reloads the given WorkflowEvent with the latest version from the database.
int	resetEventsForApproval(List<Long> sandBoxItemIds) Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances and reset the status information for an WorkflowEvent that has already been promoted and is about to be approved.
List<com.broadleafcommerce.jobsevents.domain.ProcessStatus>	retrieveDeploymentStatus(long workflowDeploymentId) Find any and all ProcessStatus records (active or archived) associated with the WorkflowDeployment id.
List<com.broadleafcommerce.jobsevents.domain.ProcessStatus>	retrieveEventStatus(long workflowEventId) Find any and all ProcessStatus records (active or archived) associated with the WorkflowEvent id.
String	retryDeployment(Long workflowDeploymentId) Notify the system to retry deployment on a WorkflowDeployment id.
String	retryPromotion(Long workflowEventId) Notify the system to retry promotion on a WorkflowEvent id.
WorkflowDeployment	save(WorkflowDeployment deployment) Saves the given WorkflowDeployment
WorkflowEvent	save(WorkflowEvent event) Saves the given WorkflowEvent
com.broadleafcommerce.jobsevents.domain.ScheduledJob	saveScheduledJob(com.broadleafcommerce.jobsevents.domain.ScheduledJob job) Saves the scheduled job
void	startDeployment(Long deploymentId) Set the StatusTiming#getDateStarted() on WorkflowDeployment.
void	updateApprovalStatus(Long eventId) Marks the given WorkflowEvent id as approved.
void	updateEventDeployment(List<Long> eventIds, WorkflowDeployment deployment)
void	updateEventDeployment(Long eventId, WorkflowDeployment deployment) Associates the given WorkflowEvent id to the given WorkflowDeployment.
void	updateEventSetupStatus(List<Long> eventIds, int status) Change the setup status for one or more WorkflowEvent instances.

Methods inherited from class java.lang.Object

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

Field Detail

dao

protected WorkflowEventDao dao

systemEventDao

protected com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDao systemEventDao

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

processDao

protected com.broadleafcommerce.jobsevents.dao.ProcessManagementDao processDao

adminRemoteSecurityService

protected org.broadleafcommerce.openadmin.server.security.remote.SecurityVerifier adminRemoteSecurityService

publisher

@Autowired
protected org.springframework.context.ApplicationEventPublisher publisher

lockUtil

protected ExecutionLockUtil lockUtil

workflowLogger

protected EnterpriseWorkflowLogger workflowLogger

Constructor Detail

WorkflowEventServiceImpl

public WorkflowEventServiceImpl()

Method Detail

save

@Transactional(value="blTransactionManager")
public WorkflowEvent save(WorkflowEvent event)

Description copied from interface: WorkflowEventService

Saves the given WorkflowEvent

Specified by:

save in interface WorkflowEventService

Returns:

the persisted WorkflowEvent

delete

@Transactional(value="blTransactionManager")
public void delete(WorkflowEvent event)

Description copied from interface: WorkflowEventService

Deletes the specified WorkflowEvent from the database

Specified by:

delete in interface WorkflowEventService

refresh

@Transactional(value="blTransactionManager")
public WorkflowEvent refresh(WorkflowEvent event)

Description copied from interface: WorkflowEventService

Reloads the given WorkflowEvent with the latest version from the database.

Specified by:

refresh in interface WorkflowEventService

Returns:

the refreshed WorkflowEvent

findById

public WorkflowEvent findById(Long id)

Description copied from interface: WorkflowEventService

Finds a given WorkflowEvent by its internal id

Specified by:

findById in interface WorkflowEventService

Returns:

the WorkflowEvent

findByIds

public List<WorkflowEvent> findByIds(List<Long> ids)

Description copied from interface: WorkflowEventService

Finds several WorkflowEvents by the given internal ids

Specified by:

findByIds in interface WorkflowEventService

Returns:

the list of WorkflowEvents

findAllForSandBox

public List<WorkflowEvent> findAllForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventService

Finds all WorkflowEvents that are currently associated with the given sandbox

Specified by:

findAllForSandBox in interface WorkflowEventService

Returns:

the list of WorkflowEvents

findAllNotDeployedIdsForSandBox

public List<Long> findAllNotDeployedIdsForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventService

Finds the ids corresponding to WorkflowEvents that are in the specified sandbox and are not yet deployed.

Specified by:

findAllNotDeployedIdsForSandBox in interface WorkflowEventService

Returns:

a list of WorkflowEvent ids

findAllDeployingIdsForSandBox

public List<Long> findAllDeployingIdsForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventService

Finds the ids corresponding to WorkflowEvents that are in the specified sandbox and are currently deploying.

Specified by:

findAllDeployingIdsForSandBox in interface WorkflowEventService

Returns:

findAllIdsForSandBox

public List<Long> findAllIdsForSandBox(Long sandBoxId)

Description copied from interface: WorkflowEventService

Finds the ids corresponding to WorkflowEvents that are in the specified sandbox.

Specified by:

findAllIdsForSandBox in interface WorkflowEventService

Returns:

a list of WorkflowEvent ids

logEvent

@Transactional(value="blTransactionManager")
public WorkflowEvent logEvent(SandBoxActionType actionType,
                                                                           String eventName,
                                                                           String originalMessage,
                                                                           String eventMessage,
                                                                           org.broadleafcommerce.openadmin.server.security.domain.AdminUser author,
                                                                           org.broadleafcommerce.common.sandbox.domain.SandBox sandBox)

Description copied from interface: WorkflowEventService

Creates a WorkflowEvent that represents the given parameters.

Specified by:

logEvent in interface WorkflowEventService

Returns:

the created WorkflowEvent

findBySandBoxItem

public List<Long> findBySandBoxItem(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventService

Finds the WorkflowEvents ids that are associated with the given WorkflowSandBoxItem ids

Specified by:

findBySandBoxItem in interface WorkflowEventService

Returns:

the list of WorkflowEvents

findEntitiesBySandBoxItem

public List<WorkflowEvent> findEntitiesBySandBoxItem(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventService

Finds the WorkflowEvents that are associated with the given WorkflowSandBoxItem ids

Specified by:

findEntitiesBySandBoxItem in interface WorkflowEventService

Returns:

completeEvents

public int completeEvents(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventService

Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances that have no un-completed WorkflowSandBoxItem instances and set those events to completed status.

Specified by:

completeEvents in interface WorkflowEventService

Returns:

resetEventsForApproval

public int resetEventsForApproval(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowEventService

Based on the list of WorkflowSandBoxItem ids, find all associated WorkflowEvent instances and reset the status information for an WorkflowEvent that has already been promoted and is about to be approved.

Specified by:

resetEventsForApproval in interface WorkflowEventService

Returns:

save

@Transactional(value="blTransactionManager")
public WorkflowDeployment save(WorkflowDeployment deployment)

Description copied from interface: WorkflowEventService

Saves the given WorkflowDeployment

Specified by:

save in interface WorkflowEventService

Returns:

the persisted WorkflowDeployment

detach

public void detach(WorkflowDeployment deployment)

Description copied from interface: WorkflowEventService

Detaches the given WorkflowDeployment instance from the entity manager.

Specified by:

detach in interface WorkflowEventService

archiveWorkflowEventsBySandBoxId

@Transactional(value="blTransactionManager")
public void archiveWorkflowEventsBySandBoxId(Long sandBoxId)

Description copied from interface: WorkflowEventService

Archive all WorkflowEvents associated to the given SandBox

Specified by:

archiveWorkflowEventsBySandBoxId in interface WorkflowEventService

updateApprovalStatus

@Transactional(value="blTransactionManager")
public void updateApprovalStatus(Long eventId)

Description copied from interface: WorkflowEventService

Marks the given WorkflowEvent id as approved.

Specified by:

updateApprovalStatus in interface WorkflowEventService

updateEventDeployment

@Transactional(value="blTransactionManager")
public void updateEventDeployment(Long eventId,
                                                                               WorkflowDeployment deployment)

Description copied from interface: WorkflowEventService

Associates the given WorkflowEvent id to the given WorkflowDeployment.

Specified by:

updateEventDeployment in interface WorkflowEventService

updateEventDeployment

@Transactional(value="blTransactionManager")
public void updateEventDeployment(List<Long> eventIds,
                                                                               WorkflowDeployment deployment)

Specified by:

updateEventDeployment in interface WorkflowEventService

updateEventSetupStatus

@Transactional(value="blTransactionManager")
public void updateEventSetupStatus(List<Long> eventIds,
                                                                                int status)

Description copied from interface: WorkflowEventService

Change the setup status for one or more WorkflowEvent instances.

Specified by:

updateEventSetupStatus in interface WorkflowEventService

Parameters:

eventIds - the primary key values for the WorkflowEvent instances to update

status - arbitrary status - known values defined in WorkflowEventSetupStatus

findDeploymentByJob

public WorkflowDeployment findDeploymentByJob(Long jobId)

Description copied from interface: WorkflowEventService

Finds a WorkflowDeployment instance that corresponds to the given job id

Specified by:

findDeploymentByJob in interface WorkflowEventService

Returns:

the WorkflowDeployment

findDeploymentById

public WorkflowDeployment findDeploymentById(Long id)

Description copied from interface: WorkflowEventService

Finds a WorkflowDeployment instance that corresponds to the given id

Specified by:

findDeploymentById in interface WorkflowEventService

Returns:

the WorkflowDeployment

startDeployment

@Transactional(value="blTransactionManager")
public void startDeployment(Long deploymentId)

Description copied from interface: WorkflowEventService

Set the StatusTiming#getDateStarted() on WorkflowDeployment. Currently, this requires the 'enable.status.timing' property be set to 'true', as the StatusTiming fields are conditionally weaved into the domain. Additionally, the 'DATE_STARTED' column must be setup on the BLC_SNDBX_WRKFLW_DEPLOY table. See StatusTimingImpl for more info on the field.

Specified by:

startDeployment in interface WorkflowEventService

finishDeployment

@Transactional(value="blTransactionManager")
public void finishDeployment(Long deploymentId)

Description copied from interface: WorkflowEventService

Set the StatusTiming#getDateFinished() on WorkflowDeployment. Currently, this requires the 'enable.status.timing' property be set to 'true', as the StatusTiming fields are conditionally weaved into the domain. Additionally, the 'DATE_FINISHED' column must be setup on the BLC_SNDBX_WRKFLW_DEPLOY table. See StatusTimingImpl for more info on the field.

Specified by:

finishDeployment in interface WorkflowEventService

findDeploymentsByEvents

public List<WorkflowDeployment> findDeploymentsByEvents(List<Long> events)

Description copied from interface: WorkflowEventService

Finds a list of WorkflowDeployments that are associated to the given list of WorkflowEvent ids.

Specified by:

findDeploymentsByEvents in interface WorkflowEventService

Returns:

the list of WorkflowDeployments

readEventIdsByDeployment

public List<Long> readEventIdsByDeployment(Long deploymentId)

Description copied from interface: WorkflowEventService

Based on the id value from a WorkflowDeployment, find all associated WorkflowEvent.getId() values.

Specified by:

readEventIdsByDeployment in interface WorkflowEventService

Returns:

findAllFutureDeployments

public List<WorkflowDeployment> findAllFutureDeployments()

Description copied from interface: WorkflowEventService

Finds a list of WorkflowDeployments that are set to deploy at a future time.

Specified by:

findAllFutureDeployments in interface WorkflowEventService

Returns:

the list of WorkflowDeployments

cancelDeployment

@Transactional(value="blTransactionManager")
public void cancelDeployment(WorkflowDeployment deployment)

Description copied from interface: WorkflowEventService

Unschedules the deployment's associated events, deletes the deployment's job and then deletes the deployment itself.

Specified by:

cancelDeployment in interface WorkflowEventService

findDeploymentIdsForCurrentUser

public List<String> findDeploymentIdsForCurrentUser()

Specified by:

findDeploymentIdsForCurrentUser in interface WorkflowEventService

Returns:

the list of WorkflowDeployment Ids

findJobByJobId

public com.broadleafcommerce.jobsevents.domain.ScheduledJob findJobByJobId(Long jobId)

Description copied from interface: WorkflowEventService

Finds the scheduled job associated with the deployment

Specified by:

findJobByJobId in interface WorkflowEventService

saveScheduledJob

@Transactional(value="blTransactionManager")
public com.broadleafcommerce.jobsevents.domain.ScheduledJob saveScheduledJob(com.broadleafcommerce.jobsevents.domain.ScheduledJob job)

Description copied from interface: WorkflowEventService

Saves the scheduled job

Specified by:

saveScheduledJob in interface WorkflowEventService

readUnscheduledEventIdsByCriticalAndApprovalStatuses

public List<Long> readUnscheduledEventIdsByCriticalAndApprovalStatuses(Long sandboxId,
                                                                       boolean isCritical,
                                                                       boolean isApproved)

Description copied from interface: WorkflowEventService

Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and WorkflowEventImpl.isCritical and that are not deployed or scheduled for deployment

Specified by:

readUnscheduledEventIdsByCriticalAndApprovalStatuses in interface WorkflowEventService

Returns:

readUnscheduledEventIdsByApprovalStatus

public List<Long> readUnscheduledEventIdsByApprovalStatus(Long sandboxId,
                                                          boolean isApproved)

Description copied from interface: WorkflowEventService

Finds all WorkflowEvents associated by WorkflowEventImpl.sandBox and that are not deployed or scheduled for deployment

Specified by:

readUnscheduledEventIdsByApprovalStatus in interface WorkflowEventService

Returns:

retryPromotion

@Transactional(value="blTransactionManager")
public String retryPromotion(Long workflowEventId)
                                                                   throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Description copied from interface: WorkflowEventService

Notify the system to retry promotion on a WorkflowEvent id. Presumably, the requested event is in a stuck SandBoxActionType.PROGRESS state without and active ProcessStatus. In such a state, the system is unaware of the in-progress event and the event is not actively being worked on by any node.

Specified by:

retryPromotion in interface WorkflowEventService

Returns:

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

retryDeployment

@Transactional(value="blTransactionManager")
public String retryDeployment(Long workflowDeploymentId)
                                                                    throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Description copied from interface: WorkflowEventService

Notify the system to retry deployment on a WorkflowDeployment id. Presumably, the requested deployment is in a stuck DeploymentStatusType.IN_PROCESS state without and active ProcessStatus. In such a state, the system is unaware of the in-progress deployment and the deployment is not actively being worked on by any node.

Specified by:

retryDeployment in interface WorkflowEventService

Returns:

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

retrieveEventStatus

public List<com.broadleafcommerce.jobsevents.domain.ProcessStatus> retrieveEventStatus(long workflowEventId)

Description copied from interface: WorkflowEventService

Find any and all ProcessStatus records (active or archived) associated with the WorkflowEvent id. Internally result quantity is limited to the last 10.

Specified by:

retrieveEventStatus in interface WorkflowEventService

Returns:

retrieveDeploymentStatus

public List<com.broadleafcommerce.jobsevents.domain.ProcessStatus> retrieveDeploymentStatus(long workflowDeploymentId)

Description copied from interface: WorkflowEventService

Find any and all ProcessStatus records (active or archived) associated with the WorkflowDeployment id. Internally result quantity is limited to the last 10.

Specified by:

retrieveDeploymentStatus in interface WorkflowEventService

Returns: