Package com.broadleafcommerce.sandbox.messaging.completion.error

Interface WorkflowRequestErrorHandler

All Known Implementing Classes:
DeploymentWorkflowRequestErrorHandler, PromotionWorkflowRequestErrorHandler, RebasingWorkflowRequestErrorHandler, RejectionWorkflowRequestErrorHandler, ReversionWorkflowRequestErrorHandler
public interface WorkflowRequestErrorHandler
Classes implementing this interface handle error resolution actions (like cleaning up ChangeSummary states/statuses) for specific types of transition completions. Typically this is determined by the WorkflowRequestCompletion.getRequestType().
See Also:

  • 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.
    void
    handle(com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion, String id)
    Responsible for any follow-up actions (like cleaning up ChangeSummary states/statuses) required after external microservices have met their responsibilities for a sandbox workflow transition triggered by a TransitionRequest.

  • Method Details

    • canHandle

      boolean canHandle(@NonNull com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion)
      Determines if this handler can handle the given WorkflowRequestCompletion. This is typically done by checking the WorkflowRequestCompletion.getRequestType().
      Parameters:
      completion - a WorkflowRequestCompletion received over the WorkflowRequestCompletionConsumer channel or manually from TransitionErrorEndpoint
      Returns:
      whether this handler can handle errors for the given WorkflowRequestCompletion

    • handle

      void handle(@NonNull com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion completion, String id)
      Responsible for any follow-up actions (like cleaning up ChangeSummary states/statuses) required after external microservices have met their responsibilities for a sandbox workflow transition triggered by a TransitionRequest.
      Parameters:
      completion - a WorkflowRequestCompletion received over the WorkflowRequestCompletionConsumer channel or manually from TransitionErrorEndpoint
      id - the id of the top-most entity to handle the error, typically either ChangeSummary, ChangeSummaryGroup, or ChangeDeploy, depending on the WorkflowRequestCompletion.getRequestType()