Class DefaultWorkflowRequestCompletionNotifier
java.lang.Object
com.broadleafcommerce.data.tracking.core.transition.DefaultWorkflowRequestCompletionNotifier
- All Implemented Interfaces:
WorkflowRequestCompletionNotifier
public class DefaultWorkflowRequestCompletionNotifier
extends Object
implements WorkflowRequestCompletionNotifier
-
Constructor Summary
ConstructorDescriptionDefaultWorkflowRequestCompletionNotifier
(WorkflowRequestCompletionProducer completionProducer) -
Method Summary
Modifier and TypeMethodDescriptionboolean
notifyOfCompletion
(TransitionRequest request, boolean success, Exception e) Sends notification of aTransitionRequest's
completion including whether success or failure.boolean
notifyOfCompletion
(WorkflowJobSchedulingRequest request, boolean success, Exception e) Sends notification of aWorkflowJobSchedulingRequest's
completion including whether success or failure.boolean
notifyOfCompletion
(WorkflowJobUnschedulingRequest request, boolean success, Exception e) Sends notification of aWorkflowJobUnschedulingRequest's
completion including whether success or failure.protected boolean
sendTransitionCompletion
(WorkflowRequestCompletion completion, String simpleName, String contextId, String className) Send the completion message on the outgoing channel
-
Constructor Details
-
DefaultWorkflowRequestCompletionNotifier
public DefaultWorkflowRequestCompletionNotifier(WorkflowRequestCompletionProducer completionProducer)
-
-
Method Details
-
notifyOfCompletion
public boolean notifyOfCompletion(@NonNull TransitionRequest request, boolean success, @Nullable Exception e) Description copied from interface:WorkflowRequestCompletionNotifier
Sends notification of aTransitionRequest's
completion including whether success or failure.- Specified by:
notifyOfCompletion
in interfaceWorkflowRequestCompletionNotifier
- Parameters:
request
-TransitionRequest
the completion of which to send a notification.success
- Whether theTransitionRequest
was successful or failed.e
-Exception
related to the request's failure if applicable.- Returns:
- Whether the notification was sent successfully.
-
notifyOfCompletion
public boolean notifyOfCompletion(@NonNull WorkflowJobSchedulingRequest request, boolean success, @Nullable Exception e) Description copied from interface:WorkflowRequestCompletionNotifier
Sends notification of aWorkflowJobSchedulingRequest's
completion including whether success or failure.- Specified by:
notifyOfCompletion
in interfaceWorkflowRequestCompletionNotifier
- Parameters:
request
-WorkflowJobSchedulingRequest
the completion of which to send a notification.success
- Whether theWorkflowJobSchedulingRequest
was successful or failed.e
-Exception
related to the request's failure if applicable.- Returns:
- Whether the notification was sent successfully.
-
notifyOfCompletion
public boolean notifyOfCompletion(@NonNull WorkflowJobUnschedulingRequest request, boolean success, @Nullable Exception e) Description copied from interface:WorkflowRequestCompletionNotifier
Sends notification of aWorkflowJobUnschedulingRequest's
completion including whether success or failure.- Specified by:
notifyOfCompletion
in interfaceWorkflowRequestCompletionNotifier
- Parameters:
request
-WorkflowJobUnschedulingRequest
the completion of which to send a notification.success
- Whether theWorkflowJobUnschedulingRequest
was successful or failed.e
-Exception
related to the request's failure if applicable.- Returns:
- Whether the notification was sent successfully.
-
sendTransitionCompletion
protected boolean sendTransitionCompletion(WorkflowRequestCompletion completion, String simpleName, String contextId, String className) Send the completion message on the outgoing channel- Parameters:
completion
- The completion message to sendsimpleName
- The short class name of the trackable entity that was transitionedcontextId
- The contextId of the trackable entity that was transitionedclassName
- The fully qualified class name of the trackable entity that was transitioned- Returns:
- Whether or not the message was successfully sent
-