Package com.broadleafcommerce.sandbox.messaging.completion

Class DeploymentJobSchedulingRequestCompletionHandler

java.lang.Object

com.broadleafcommerce.sandbox.messaging.completion.DeploymentJobSchedulingRequestCompletionHandler

All Implemented Interfaces:

WorkflowRequestCompletionHandler

public class DeploymentJobSchedulingRequestCompletionHandler
extends Object
implements WorkflowRequestCompletionHandler

This handler deals with updating the states and statuses of ChangeDeploys that have just finished being scheduled.

Constructor Summary

Constructors

Constructor	Description
DeploymentJobSchedulingRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService, ChangeSummaryGroupService<ChangeSummaryGroup> groupService, ChangeDeployService<ChangeDeploy> changeDeployService, DeploymentJobSchedulingRequestErrorHandler errorHandler)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Determines if this handler can handle the given WorkflowRequestCompletion.
protected void	finishDeploymentScheduling(String deployId)	Performs the final steps in scheduling a ChangeDeploy: Locks the deployment then updates it status as ChangeStatusType.FINISHED and its state as ChangeState.SCHEDULED.
protected void	finishGroupScheduling(String groupId)	Performs the final steps in scheduling a ChangeSummaryGroup: Locks the group then updates its status as ChangeStatusType.FINISHED and its state as ChangeState.SCHEDULED.
protected void	finishScheduling(ChangeDeploy deployment, Collection<ChangeSummaryGroup> changeSummaryGroups)	Performs the final steps in scheduling a ChangeDeploy and its ChangeSummaryGroups by updating their states to ChangeState.SCHEDULED and their statuses to ChangeStatusType.FINISHED.
protected void	finishSummaryScheduling(Collection<ChangeSummaryGroup> groups)	Performs the final steps in scheduling a ChangeSummary: Updates a ChangeSummary's status as ChangeStatusType.FINISHED and its state as ChangeState.SCHEDULED.
protected ChangeDeployService<ChangeDeploy>	getChangeDeployService()
protected DeploymentJobSchedulingRequestErrorHandler	getErrorHandler()
protected ChangeSummaryGroupService<ChangeSummaryGroup>	getGroupService()
protected ChangeSummaryService<ChangeSummary>	getSummaryService()
void	handle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Gleans the ID of the ChangeDeploy for which to complete the scheduling process and whether the microservice sending the completion message encountered errors while performing the scheduling.

Methods inherited from class java.lang.Object

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

Constructor Details

DeploymentJobSchedulingRequestCompletionHandler

public DeploymentJobSchedulingRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService,
 ChangeSummaryGroupService<ChangeSummaryGroup> groupService,
 ChangeDeployService<ChangeDeploy> changeDeployService,
 DeploymentJobSchedulingRequestErrorHandler errorHandler)

Method Details

canHandle

public boolean canHandle(@NonNull
 com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)

Description copied from interface: WorkflowRequestCompletionHandler

Determines if this handler can handle the given WorkflowRequestCompletion. This is typically done by checking the WorkflowRequestCompletion.getRequestType().

Specified by:

canHandle in interface WorkflowRequestCompletionHandler

Parameters:

completion - a WorkflowRequestCompletion received over the WorkflowRequestCompletionConsumer channel

Returns:

whether this handler can handle the given WorkflowRequestCompletion

handle

public void handle(@NonNull
 com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)

Gleans the ID of the ChangeDeploy for which to complete the scheduling process and whether the microservice sending the completion message encountered errors while performing the scheduling.

If errors were encountered, the statuses of the group and summary are udpated to ChangeStatusType.ERROR_SCHEDULE and the error stack trace is recorded onto them.

Specified by:

handle in interface WorkflowRequestCompletionHandler

Parameters:

completion - a WorkflowRequestCompletion received over the WorkflowRequestCompletionConsumer channel containing information about the scheduled ChangeDeploy and one of its ChangeSummaryGroup's ChangeSummaries

finishScheduling

protected void finishScheduling(ChangeDeploy deployment,
 Collection<ChangeSummaryGroup> changeSummaryGroups)

Performs the final steps in scheduling a ChangeDeploy and its ChangeSummaryGroups by updating their states to ChangeState.SCHEDULED and their statuses to ChangeStatusType.FINISHED.

Parameters:

deployment - The deployment to finish scheduling

changeSummaryGroups - The ChangeSummaryGroup instances belonging to the deployment.

Throws:

QualifiedStateException - Thrown if the deployment or a group fail to be updated

finishSummaryScheduling

protected void finishSummaryScheduling(Collection<ChangeSummaryGroup> groups)

Performs the final steps in scheduling a ChangeSummary: Updates a ChangeSummary's status as ChangeStatusType.FINISHED and its state as ChangeState.SCHEDULED.

Parameters:

groups - Stream of ChangeSummaryGroups from which to derive the IDs of ChangeSummaries.

finishGroupScheduling

protected void finishGroupScheduling(String groupId)

Performs the final steps in scheduling a ChangeSummaryGroup: Locks the group then updates its status as ChangeStatusType.FINISHED and its state as ChangeState.SCHEDULED.

Parameters:

groupId - The ID of the group to update

Throws:

QualifiedStateException - Thrown if the update fails.

finishDeploymentScheduling

protected void finishDeploymentScheduling(String deployId)

Performs the final steps in scheduling a ChangeDeploy: Locks the deployment then updates it status as ChangeStatusType.FINISHED and its state as ChangeState.SCHEDULED.

Parameters:

deployId - The ID of the deployment to update

Throws:

QualifiedStateException - Thrown if the update fails.

getSummaryService

protected ChangeSummaryService<ChangeSummary> getSummaryService()

getGroupService

protected ChangeSummaryGroupService<ChangeSummaryGroup> getGroupService()

getChangeDeployService

protected ChangeDeployService<ChangeDeploy> getChangeDeployService()

getErrorHandler

protected DeploymentJobSchedulingRequestErrorHandler getErrorHandler()