Record Class DeliverySemantics

java.lang.Object
java.lang.Record
org.j7m.middleware.api.reliability.DeliverySemantics
Record Components:
mode - requested delivery mode
retrySafe - whether retry is known to be safe
effectivelyOncePattern - whether effectively-once pattern metadata is present
All Implemented Interfaces:
Serializable
public record DeliverySemantics(DeliveryMode mode, boolean retrySafe, boolean effectivelyOncePattern) extends Record implements Serializable
Delivery semantics selected for an invocation.

The record is immutable, serializable, and thread-safe. Generic exactly-once distributed execution is represented as unsupported and must be rejected by evaluators.

See Also:

  • Constructor Details

    • DeliverySemantics

      public DeliverySemantics(DeliveryMode mode, boolean retrySafe, boolean effectivelyOncePattern)
      Creates validated delivery semantics.

  • Method Details

    • atMostOnceBestEffort

      public static DeliverySemantics atMostOnceBestEffort()
      Returns at-most-once best-effort semantics.
      Returns:
      semantics

    • atLeastOnceRetryable

      public static DeliverySemantics atLeastOnceRetryable()
      Returns at-least-once retryable semantics.
      Returns:
      semantics

    • effectivelyOncePatternSupport

      public static DeliverySemantics effectivelyOncePatternSupport()
      Returns effectively-once pattern metadata semantics.
      Returns:
      semantics

    • unsupportedExactlyOnce

      public static DeliverySemantics unsupportedExactlyOnce()
      Returns an unsupported generic exactly-once request.
      Returns:
      semantics

    • unsupportedExactlyOnceRequested

      public boolean unsupportedExactlyOnceRequested()
      Reports whether the request is a generic exactly-once claim.
      Returns:
      true when unsupported exactly-once was requested

    • 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.

    • mode

      public DeliveryMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • retrySafe

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

    • effectivelyOncePattern

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