Package com.broadleafcommerce.sandbox.messaging.job

Interface TriggeredSandboxJobEventHandler

All Known Implementing Classes:
TriggeredDeploymentJobEventHandler
public interface TriggeredSandboxJobEventHandler
Classes implementing this interface handle triggered scheduled jobs relating to the sandbox service. The most common example is that of handling sandbox deployment requests that were previously scheduled.
Author:
Nathan Moore (nathandmoore)

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canHandle(com.broadleafcommerce.common.messaging.domain.ScheduledJobRef jobRef)
    Determines if this handler can handle the given ScheduledJobRef.
    void
    handle(com.broadleafcommerce.common.messaging.domain.ScheduledJobRef jobRef)
    Responsible for executing actions in response to a scheduled job such as kicking off a new WorkflowDeployRequest.

  • Method Details

    • canHandle

      boolean canHandle(@NonNull com.broadleafcommerce.common.messaging.domain.ScheduledJobRef jobRef)
      Determines if this handler can handle the given ScheduledJobRef. This is typically done by checking the ScheduledJobRef.getType().
      Parameters:
      jobRef - a ScheduledJobRef received over the TriggeredJobEvent input channel
      Returns:
      whether this handler can handle the given ScheduledJobRef.

    • handle

      void handle(@NonNull com.broadleafcommerce.common.messaging.domain.ScheduledJobRef jobRef)
      Responsible for executing actions in response to a scheduled job such as kicking off a new WorkflowDeployRequest.
      Parameters:
      jobRef - a ScheduledJobRef received over the TriggeredJobEvent input channel