Package com.broadleafcommerce.sandbox.messaging.completion

Class PromotionWorkflowRequestCompletionHandler

java.lang.Object

com.broadleafcommerce.sandbox.messaging.completion.PromotionWorkflowRequestCompletionHandler

All Implemented Interfaces:

WorkflowRequestCompletionHandler

public class PromotionWorkflowRequestCompletionHandler
extends Object
implements WorkflowRequestCompletionHandler

Handles any WorkflowRequestCompletions resulting from WorkflowPromoteRequest

Author:

Jeff Fischer, Nathan Moore (nathandmoore), Phillip Verheyden (phillipuniverse)

Constructor Summary

Constructors

Constructor	Description
PromotionWorkflowRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService, ChangeSummaryGroupService<ChangeSummaryGroup> groupService, PromotionWorkflowRequestErrorHandler errorHandler, IndexNotificationService indexNotificationService)

Method Summary

Modifier and Type	Method	Description
protected boolean	areAllSummariesFinished(List<String> ids, String sandbox)	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	finishGroupPromotion(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.
protected void	finishPromotion(String groupId, com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Performs the final steps in promoting a ChangeSummaryGroup and its ChangeSummaries: Updates the state of the ChangeSummary indicated in the request as ChangeState.PROMOTED and its status as ChangeStatusType.FINISHED If this is the last summary in the group to finish, then the ChangeSummaryGroup is marked likewise.
protected void	finishSummaryPromotion(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Performs the final steps in promoting a ChangeSummary: Updates a ChangeSummary's status as ChangeStatusType.FINISHED and its state as ChangeState.PROMOTED.
protected PromotionWorkflowRequestErrorHandler	getErrorHandler()
protected ChangeSummaryGroupService<ChangeSummaryGroup>	getGroupService()
protected IndexNotificationService	getIndexNotificationService()
protected ChangeSummaryService<ChangeSummary>	getSummaryService()
void	handle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Gleans a ChangeSummaryGroup ID and a ChangeSummary ID from the competion message.
protected boolean	isGroupInErrorState(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.
void	setProperties(CompletionCleanupProperties properties)
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

PromotionWorkflowRequestCompletionHandler

public PromotionWorkflowRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService,
 ChangeSummaryGroupService<ChangeSummaryGroup> groupService,
 PromotionWorkflowRequestErrorHandler 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 a ChangeSummaryGroup ID and a ChangeSummary ID from the competion message. If the promotion was successful, then marks the summary as ChangeStatusType.FINISHED and ChangeState.PROMOTED. If successful and this is the last change summary in the group, also marks the group as finished and promoted.

If the promotion failed, then marks the summary and group as ChangeStatusType.ERROR_PROMOTE.

Specified by:

handle in interface WorkflowRequestCompletionHandler

Parameters:

completion - a WorkflowRequestCompletion received over the WorkflowRequestCompletionConsumer channel with information about the promoted changes

finishPromotion

protected void finishPromotion(String groupId,
 com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)

Performs the final steps in promoting a ChangeSummaryGroup and its ChangeSummaries:

• Updates the state of the ChangeSummary indicated in the request as ChangeState.PROMOTED
• and its status as ChangeStatusType.FINISHED
• If this is the last summary in the group to finish, then the ChangeSummaryGroup is marked likewise.

Parameters:

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

groupId - The ID of the group 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.

finishSummaryPromotion

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

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

Parameters:

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

Throws:

QualifiedStateException - Thrown if the update fails.

finishGroupPromotion

@Deprecated(forRemoval=true,
            since="2.0.1")
protected void finishGroupPromotion(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().

Obtains a lock on the ChangeSummaryGroup and updates its status to ChangeStatusType.FINISHED and state to ChangeState.PROMOTED.

Parameters:

group - the ChangeSummaryGroup to update

Throws:

QualifiedStateException - Thrown if the update fails.

isGroupInErrorState

@Deprecated(forRemoval=true,
            since="2.0.1")
protected boolean isGroupInErrorState(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().

Checks if the ChangeSummaryGroup has already been marked as having encountered an error during promotions.

Usually, this will happen due to an error in one of the group's ChangeSummaries rather than because of an error processing the group itself.

Parameters:

group - The ChangeSummaryGroup whose status to check

Returns:

whether the group has already been marked as having encountered an error.

areAllSummariesFinished

@Deprecated(forRemoval=true,
            since="2.0.1")
protected boolean areAllSummariesFinished(List<String> ids,
 String sandbox)

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 promoted.

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

Parameters:

ids - All the change summary ids that will be associated with the group for the transition

sandbox - The sandbox in which the transition is taking place

Returns:

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

getSummaryService

protected ChangeSummaryService<ChangeSummary> getSummaryService()

getGroupService

protected ChangeSummaryGroupService<ChangeSummaryGroup> getGroupService()

getErrorHandler

protected PromotionWorkflowRequestErrorHandler getErrorHandler()

getIndexNotificationService

protected IndexNotificationService getIndexNotificationService()

setProperties

@Autowired
public void setProperties(CompletionCleanupProperties properties)

setSummaryRepository

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