Package com.broadleafcommerce.sandbox.messaging.completion

Class RejectionWorkflowRequestCompletionHandler

java.lang.Object

com.broadleafcommerce.sandbox.messaging.completion.RejectionWorkflowRequestCompletionHandler

All Implemented Interfaces:

WorkflowRequestCompletionHandler

public class RejectionWorkflowRequestCompletionHandler
extends Object
implements WorkflowRequestCompletionHandler

This handler deals with cleaning up rejected ChangeSummaryGroups' states and statuses.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	archiveGroup(ChangeSummaryGroup group)	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	areAllSummariesFinished(ChangeSummaryGroup group)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canHandle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Determines if this handler can handle the given WorkflowRequestCompletion.
protected void	finishRejection(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion, String groupId)	Performs the final steps in rejecting a ChangeSummaryGroup and its ChangeSummaries: Updates the state of the ChangeSummary indicated in the request as ChangeState.USER and its status as ChangeStatusType.FINISHED If this is the last summary in the group to finish, then the ChangeSummaryGroup is archived.
protected void	finishSummaryRejection(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Performs the final steps in rejecting a ChangeSummary: Updates a ChangeSummary's status as ChangeStatusType.FINISHED and its state as ChangeState.USER.
protected RejectionWorkflowRequestErrorHandler	getErrorHandler()
protected ChangeSummaryGroupService<ChangeSummaryGroup>	getGroupService()
protected IndexNotificationService	getIndexNotificationService()
protected ChangeSummaryService<ChangeSummary>	getSummaryService()
void	handle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)	Gleans the ID of the ChangeSummaryGroup for which to complete the rejection process and whether the microservice sending the completion message encountered errors while performing the rejection.
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

RejectionWorkflowRequestCompletionHandler

public RejectionWorkflowRequestCompletionHandler(ChangeSummaryService<ChangeSummary> summaryService,
 ChangeSummaryGroupService<ChangeSummaryGroup> groupService,
 RejectionWorkflowRequestErrorHandler 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 ChangeSummaryGroup for which to complete the rejection process and whether the microservice sending the completion message encountered errors while performing the rejection.

If errors were encountered, the statuses of the group and summary are udpated to ChangeStatusType.ERROR_REJECT 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 rejected ChangeSummaryGroup and one of its ChangeSummaries for which to complete the rejection process.

finishRejection

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

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

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

Parameters:

completion - The WorkflowRequestCompletion indicating the group and summary for which to finish the rejection 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.

finishSummaryRejection

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

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

Parameters:

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

Throws:

QualifiedStateException - Thrown if the update fails.

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.

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

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

Parameters:

group - The ChangeSummaryGroup to potentially finish rejecting

Returns:

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

archiveGroup

@Deprecated(forRemoval=true,
            since="2.0.1")
protected void archiveGroup(ChangeSummaryGroup group)

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

Obtains a lock on the ChangeSummaryGroup and updates its status to ChangeStatusType.REJECTED and marks it as archived.

Parameters:

group - the ChangeSummaryGroup to update

Throws:

QualifiedStateException - Thrown if the update fails.

getSummaryService

protected ChangeSummaryService<ChangeSummary> getSummaryService()

getGroupService

protected ChangeSummaryGroupService<ChangeSummaryGroup> getGroupService()

getErrorHandler

protected RejectionWorkflowRequestErrorHandler 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)