Class StepInterruptedException

All Implemented Interfaces:
Serializable

public class StepInterruptedException extends StepFailedException
Exception thrown into the workflow body when a step's blocking wait is interrupted because the workflow itself reached a terminal state (cancelled, failed, timed out) or the engine is shutting down.

A subtype of StepFailedException: callers that want to handle any step-level failure can catch the parent; callers that need to distinguish this specific case can catch this type. Distinct from StepCancellationException, which is a per-step cancellation with its own durable <step>:CANCELLED record.

No durable event backs this exception: the step's last recorded event-log state stays STARTED. This is purely an in-body signal so the workflow body can run compensation or cleanup logic around its blocking wait; it carries no bearing on what gets persisted.

Since:
5.4.0
Author:
Stefan Dragisic
See Also:
  • Constructor Details

    • StepInterruptedException

      public StepInterruptedException(String message)
      Constructs a StepInterruptedException with a descriptive message.
      Parameters:
      message - the detail message describing why the wait was interrupted
    • StepInterruptedException

      public StepInterruptedException(String message, Throwable cause)
      Constructs a StepInterruptedException with a message and underlying cause.
      Parameters:
      message - the detail message describing why the wait was interrupted
      cause - the underlying cause of the interruption
    • StepInterruptedException

      public StepInterruptedException(Throwable cause)
      Constructs a StepInterruptedException wrapping an underlying cause.
      Parameters:
      cause - the underlying cause of the interruption