Package com.broadleafcommerce.data.tracking.core.transition

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

Constructors

Constructor	Description
DefaultWorkflowRequestCompletionNotifier(WorkflowRequestCompletionProducer completionProducer)

Method Summary

Modifier and Type	Method	Description
boolean	notifyOfCompletion(TransitionRequest request, boolean success, Exception e)	Sends notification of a TransitionRequest's completion including whether success or failure.
boolean	notifyOfCompletion(WorkflowJobSchedulingRequest request, boolean success, Exception e)	Sends notification of a WorkflowJobSchedulingRequest's completion including whether success or failure.
boolean	notifyOfCompletion(WorkflowJobUnschedulingRequest request, boolean success, Exception e)	Sends notification of a WorkflowJobUnschedulingRequest'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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWorkflowRequestCompletionNotifier

public DefaultWorkflowRequestCompletionNotifier(WorkflowRequestCompletionProducer completionProducer)

Method Detail

notifyOfCompletion

public boolean notifyOfCompletion(@NonNull
                                  TransitionRequest request,
                                  boolean success,
                                  @Nullable
                                  Exception e)

Description copied from interface: WorkflowRequestCompletionNotifier

Sends notification of a TransitionRequest's completion including whether success or failure.

Specified by:

notifyOfCompletion in interface WorkflowRequestCompletionNotifier

Parameters:

request - TransitionRequest the completion of which to send a notification.

success - Whether the TransitionRequest 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 a WorkflowJobSchedulingRequest's completion including whether success or failure.

Specified by:

notifyOfCompletion in interface WorkflowRequestCompletionNotifier

Parameters:

request - WorkflowJobSchedulingRequest the completion of which to send a notification.

success - Whether the WorkflowJobSchedulingRequest 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 a WorkflowJobUnschedulingRequest's completion including whether success or failure.

Specified by:

notifyOfCompletion in interface WorkflowRequestCompletionNotifier

Parameters:

request - WorkflowJobUnschedulingRequest the completion of which to send a notification.

success - Whether the WorkflowJobUnschedulingRequest 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 send

simpleName - The short class name of the trackable entity that was transitioned

contextId - The contextId of the trackable entity that was transitioned

className - The fully qualified class name of the trackable entity that was transitioned

Returns:

Whether or not the message was successfully sent