Record Class SagaCancellationPolicy

java.lang.Object
java.lang.Record
org.j7m.middleware.api.saga.SagaCancellationPolicy
Record Components:
compensateOnCancel - whether successful steps are compensated after cancellation
cancelRunningStep - whether the currently running step may be marked cancelled
All Implemented Interfaces:
Serializable
public record SagaCancellationPolicy(boolean compensateOnCancel, boolean cancelRunningStep) extends Record implements Serializable
Saga cancellation behavior.

The policy determines whether already successful steps are compensated and whether an implementation may mark a running step as cancelled. It does not interrupt arbitrary external systems.

See Also:

  • Constructor Details

    • SagaCancellationPolicy

      public SagaCancellationPolicy(boolean compensateOnCancel, boolean cancelRunningStep)
      Creates an instance of a SagaCancellationPolicy record class.
      Parameters:
      compensateOnCancel - the value for the compensateOnCancel record component
      cancelRunningStep - the value for the cancelRunningStep record component

  • Method Details

    • compensate

      public static SagaCancellationPolicy compensate()
      Returns the default cancellation policy.
      Returns:
      policy that compensates completed steps and does not cancel a running step directly

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • compensateOnCancel

      public boolean compensateOnCancel()
      Returns the value of the compensateOnCancel record component.
      Returns:
      the value of the compensateOnCancel record component

    • cancelRunningStep

      public boolean cancelRunningStep()
      Returns the value of the cancelRunningStep record component.
      Returns:
      the value of the cancelRunningStep record component