Package org.keycloak.events.outbox

Enum Class OutboxDeliveryOutcome

java.lang.Object

java.lang.Enum<OutboxDeliveryOutcome>

org.keycloak.events.outbox.OutboxDeliveryOutcome

All Implemented Interfaces:

Serializable, Comparable<OutboxDeliveryOutcome>, Constable

public enum OutboxDeliveryOutcome
extends Enum<OutboxDeliveryOutcome>

Per-row result of an OutboxDeliveryHandler.deliver(org.keycloak.models.KeycloakSession, org.keycloak.models.jpa.entities.OutboxEntryEntity) invocation. The drainer maps each outcome to a row transition:

• DELIVERED → status DELIVERED, deliveredAt stamped.
• RETRY → attempts++, next_attempt_at pushed forward per the kind's backoff curve. Promoted to DEAD_LETTER once attempts are exhausted.
• DEAD_LETTER → terminal failure regardless of remaining attempt budget (e.g. permanent destination error). Status set to DEAD_LETTER immediately.
• ORPHANED → handler decided the row is no longer deliverable because the destination doesn't exist (e.g. the receiver client was deleted). Treated as a non-retryable terminal failure and recorded distinctly in metrics so operators can spot stream/owner leakage.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEAD_LETTER
DELIVERED
ORPHANED
RETRY

Method Summary

Modifier and Type	Method	Description
static OutboxDeliveryOutcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutboxDeliveryOutcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DELIVERED

public static final OutboxDeliveryOutcome DELIVERED

RETRY

public static final OutboxDeliveryOutcome RETRY

DEAD_LETTER

public static final OutboxDeliveryOutcome DEAD_LETTER

ORPHANED

public static final OutboxDeliveryOutcome ORPHANED

Method Details

values

public static OutboxDeliveryOutcome[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OutboxDeliveryOutcome valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null