Record Class SagaCompensationResult

java.lang.Object
java.lang.Record
org.j7m.middleware.api.saga.SagaCompensationResult
Record Components:
success - whether compensation succeeded
retryable - whether a failed compensation may be retried
reasonCode - stable machine-readable result code
metadata - redacted result metadata
All Implemented Interfaces:
Serializable
public record SagaCompensationResult(boolean success, boolean retryable, String reasonCode, Map<String,String> metadata) extends Record implements Serializable
Safe compensation result.

The result describes the outcome of an application-provided compensation action. It does not claim arbitrary external side effects were undone.

See Also:

  • Constructor Details

    • SagaCompensationResult

      public SagaCompensationResult(boolean success, boolean retryable, String reasonCode, Map<String,String> metadata)
      Creates a validated result.

  • Method Details

    • succeeded

      public static SagaCompensationResult succeeded()
      Returns a successful compensation result.
      Returns:
      immutable success result

    • failed

      public static SagaCompensationResult failed(String reasonCode, boolean retryable)
      Returns a failed compensation result.
      Parameters:
      reasonCode - stable failure reason code
      retryable - whether retry policy may retry the failure
      Returns:
      immutable failure result

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • success

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

    • retryable

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

    • reasonCode

      public String reasonCode()
      Returns the value of the reasonCode record component.
      Returns:
      the value of the reasonCode record component

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component