Package org.keycloak.events.outbox

Record Class OutboxDeliveryResult

java.lang.Object
java.lang.Record
org.keycloak.events.outbox.OutboxDeliveryResult
public record OutboxDeliveryResult(OutboxDeliveryOutcome outcome, String errorMessage) extends Record
Per-row result returned by an OutboxDeliveryHandler.deliver(org.keycloak.models.KeycloakSession, org.keycloak.models.jpa.entities.OutboxEntryEntity) invocation. Bundles the outcome with a single operator-facing errorMessage that the drainer persists into the row's last_error column.

Handlers should put as much diagnostic detail into errorMessage as fits the column (VARCHAR(2048)) — status code, response body excerpt, exception class — so admin dashboards and log scans show the failure cause without having to cross-reference timestamps in server logs.

delivered() / orphaned() return null for the message; the drainer clears last_error on a successful delivery.

  • Constructor Details

    • OutboxDeliveryResult

      public OutboxDeliveryResult(OutboxDeliveryOutcome outcome, String errorMessage)
      Creates an instance of a OutboxDeliveryResult record class.
      Parameters:
      outcome - the value for the outcome record component
      errorMessage - the value for the errorMessage record component

  • Method Details

    • delivered

      public static OutboxDeliveryResult delivered()

    • retry

      public static OutboxDeliveryResult retry(String errorMessage)

    • deadLetter

      public static OutboxDeliveryResult deadLetter(String errorMessage)

    • orphaned

      public static OutboxDeliveryResult orphaned()

    • orphaned

      public static OutboxDeliveryResult orphaned(String errorMessage)

    • 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 Objects::equals(Object,Object).
      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.

    • outcome

      public OutboxDeliveryOutcome outcome()
      Returns the value of the outcome record component.
      Returns:
      the value of the outcome record component

    • errorMessage

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