Package com.broadleafcommerce.sandbox.messaging.completion

Class DeploymentWorkflowRequestCompletionHandler

java.lang.Object

com.broadleafcommerce.sandbox.messaging.completion.DeploymentWorkflowRequestCompletionHandler

All Implemented Interfaces:

WorkflowRequestCompletionHandler

public class DeploymentWorkflowRequestCompletionHandler
extends Object
implements WorkflowRequestCompletionHandler

This handler deals with cleaning up deployed ChangeDeploys' states and statuses.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
DeploymentWorkflowRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService, ChangeSummaryGroupService<ChangeSummaryGroup> groupService, ChangeDeployService<ChangeDeploy> changeDeployService, DeploymentWorkflowRequestErrorHandler errorHandler, IndexNotificationService indexNotificationService)

Method Summary

Modifier and Type	Method	Description
protected boolean	areAllGroupsFinished(ChangeDeploy deployment)	Deprecated, for removal: This API element is subject to removal in a future version. A new, more performant cleanup process is favored instead at DefaultGroupDeployedCleanupServices.
protected boolean	areAllSummariesFinished(ChangeSummaryGroup group)	Deprecated, for removal: This API element is subject to removal in a future version. A new, more performant cleanup process is favored instead at DefaultGroupDeployedCleanupServices.
boolean	canHandle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Determines if this handler can handle the given WorkflowRequestCompletion.
protected void	finishDeployingChanges(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion, String deployId)	Performs the final steps in deploying a ChangeDeploy and its ChangeSummaryGroups and their ChangeSummaries: Updates the state of the ChangeSummary indicated in the request as ChangeState.DEPLOYED and its status as ChangeStatusType.FINISHED If this is the last summary in the group to finish, then the ChangeSummaryGroup is updated likewise. And, if this is the last group in the deployment to finish, then the ChangeDeploy is updated likewise.
protected void	finishDeployment(String deployId)	Deprecated, for removal: This API element is subject to removal in a future version. A new, more performant cleanup process is favored instead at DefaultDeployCleanupServices.
protected void	finishGroupDeployment(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Deprecated, for removal: This API element is subject to removal in a future version. A new, more performant cleanup process is favored instead at DefaultGroupDeployedCleanupServices.
protected void	finishSummaryDeployment(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Performs the final steps in deploying a ChangeSummary: Updates its status as ChangeStatusType.FINISHED and its state as ChangeState.DEPLOYED.
protected ChangeDeployService<ChangeDeploy>	getChangeDeployService()
protected DeploymentWorkflowRequestErrorHandler	getErrorHandler()
protected ChangeSummaryGroupRepository<JpaChangeSummaryGroup>	getGroupRepository()
protected ChangeSummaryGroupService<ChangeSummaryGroup>	getGroupService()
protected IndexNotificationService	getIndexNotificationService()
protected SandboxService<Sandbox>	getSandboxService()
protected ChangeSummaryService<ChangeSummary>	getSummaryService()
static Map<String,Long[]>	getThroughputCache()
void	handle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Gleans the ID of the ChangeDeploy for which to complete the deployment process and whether the microservice sending the completion message encountered errors while performing the deployment.
void	setGroupRepository(ChangeSummaryGroupRepository<JpaChangeSummaryGroup> groupRepository)
void	setProperties(CompletionCleanupProperties properties)
void	setSandboxService(SandboxService<Sandbox> sandboxService)
void	setSummaryRepository(ChangeSummaryRepository<com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable> summaryRepository)

Methods inherited from class java.lang.Object

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

Constructor Details

DeploymentWorkflowRequestCompletionHandler

public DeploymentWorkflowRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService,
 ChangeSummaryGroupService<ChangeSummaryGroup> groupService,
 ChangeDeployService<ChangeDeploy> changeDeployService,
 DeploymentWorkflowRequestErrorHandler errorHandler,
 IndexNotificationService indexNotificationService)

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 deployment process and whether the microservice sending the completion message encountered errors while performing the deployment.

If errors were encountered, the statuses of the deployment, group, and summary are updated to ChangeStatusType.ERROR_DEPLOY 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 deployed ChangeDeploy, one of its ChangeSummaryGroups, and one of the group's ChangeSummaries for which to complete the deployment process.

finishDeployingChanges

protected void finishDeployingChanges(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion,
 String deployId)

Performs the final steps in deploying a ChangeDeploy and its ChangeSummaryGroups and their ChangeSummaries:

• Updates the state of the ChangeSummary indicated in the request as ChangeState.DEPLOYED
• and its status as ChangeStatusType.FINISHED
• If this is the last summary in the group to finish, then the ChangeSummaryGroup is updated likewise.
• And, if this is the last group in the deployment to finish, then the ChangeDeploy is updated likewise.

Parameters:

completion - The WorkflowRequestCompletion indicating the deployment, group, and summary for which to finish the deployment process

deployId - The ID of the deployment gleaned from the completion message

Throws:

IllegalStateException - Thrown if the summary's ID is missing from the WorkflowRequestCompletion.getTransferTypeIdMap().

QualifiedStateException - Thrown if either the group or summary encounters errors while being updated.

finishSummaryDeployment

protected void finishSummaryDeployment(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)

Performs the final steps in deploying a ChangeSummary: Updates its status as ChangeStatusType.FINISHED and its state as ChangeState.DEPLOYED.

Parameters:

completion - The WorkflowRequestCompletion containing the information needed to identify a deployed ChangeSummary.

Throws:

QualifiedStateException - Thrown if the update fails.

IllegalStateException - Thrown if the summary's ID is missing from the WorkflowRequestCompletion.getTransferTypeIdMap().

finishGroupDeployment

@Deprecated(forRemoval=true,
            since="2.0.1")
protected void finishGroupDeployment(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)

Deprecated, for removal: This API element is subject to removal in a future version.

A new, more performant cleanup process is favored instead at DefaultGroupDeployedCleanupServices. See CompletionCleanupProperties.isEnabled().

Performs the final steps in deploying a ChangeSummaryGroup if all of its summaries have finished deploying: Locks and updates its status as ChangeStatusType.FINISHED and its state as ChangeState.DEPLOYED.

Parameters:

completion - The WorkflowRequestCompletion containing the information needed to identify a deployed ChangeSummaryGroup.

Throws:

QualifiedStateException - Thrown if the update fails.

IllegalStateException - Thrown if the group's ID is missing from the WorkflowRequestCompletion.getTransferTypeIdMap().

finishDeployment

@Deprecated(forRemoval=true,
            since="2.0.1")
protected void finishDeployment(String deployId)

Deprecated, for removal: This API element is subject to removal in a future version.

A new, more performant cleanup process is favored instead at DefaultDeployCleanupServices. See CompletionCleanupProperties.isEnabled().

Performs the final steps in deploying a ChangeDeploy if all of its change summary groups have finished deploying: Locks and updates its status as ChangeStatusType.FINISHED and its state as ChangeState.DEPLOYED.

Parameters:

deployId - The ID of the ChangeDeploy

Throws:

QualifiedStateException - Thrown if the update fails.

IllegalStateException - Thrown if the deployment's ID is missing from the WorkflowRequestCompletion.getTransferTypeIdMap().

areAllSummariesFinished

@Deprecated(forRemoval=true,
            since="2.0.1")
protected boolean areAllSummariesFinished(ChangeSummaryGroup group)

Deprecated, for removal: This API element is subject to removal in a future version.

A new, more performant cleanup process is favored instead at DefaultGroupDeployedCleanupServices. See CompletionCleanupProperties.isEnabled().

Check if all of the ChangeSummaries in the ChangeSummaryGroup have finished being deployed.

This check is done to prevent the ChangeSummaryGroup from being marked as DEPLOYED until all its summaries have been processed.

Parameters:

group - The ChangeSummaryGroup to potentially finish deploying

Returns:

whether all of the group's summaries have finished being deployed.

areAllGroupsFinished

@Deprecated(forRemoval=true,
            since="2.0.1")
protected boolean areAllGroupsFinished(ChangeDeploy deployment)

Deprecated, for removal: This API element is subject to removal in a future version.

A new, more performant cleanup process is favored instead at DefaultGroupDeployedCleanupServices. See CompletionCleanupProperties.isEnabled().

Check if all of the ChangeSummaryGroups in the ChangeDeploy have finished being deployed.

This check is done to prevent the ChangeDeploy from being marked as DEPLOYED until all its groups have been processed.

Parameters:

deployment - The ChangeDeploy to potentially finish deploying

Returns:

whether all of the deployment's groups have finished being deployed.

getThroughputCache

public static Map<String,Long[]> getThroughputCache()

getSummaryService

protected ChangeSummaryService<ChangeSummary> getSummaryService()

getGroupService

protected ChangeSummaryGroupService<ChangeSummaryGroup> getGroupService()

getChangeDeployService

protected ChangeDeployService<ChangeDeploy> getChangeDeployService()

getErrorHandler

protected DeploymentWorkflowRequestErrorHandler getErrorHandler()

getIndexNotificationService

protected IndexNotificationService getIndexNotificationService()

getSandboxService

protected SandboxService<Sandbox> getSandboxService()

setSandboxService

@Autowired
public void setSandboxService(@Nullable
 SandboxService<Sandbox> sandboxService)

getGroupRepository

protected ChangeSummaryGroupRepository<JpaChangeSummaryGroup> getGroupRepository()

setGroupRepository

@Autowired
public void setGroupRepository(ChangeSummaryGroupRepository<JpaChangeSummaryGroup> groupRepository)

setProperties

@Autowired
public void setProperties(CompletionCleanupProperties properties)

setSummaryRepository

@Autowired
public void setSummaryRepository(ChangeSummaryRepository<com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable> summaryRepository)