shared-infrastructure/com.vertyll.veds.sharedinfrastructure.saga.enums/SagaStatus

SagaStatus

enum SagaStatus : Enum<SagaStatus> (source)

Lifecycle status of a saga aggregate (Saga).

State machine (choreography flow):

STARTED ──► AWAITING_RESPONSE ──► COMPLETED                       (happy path)
   │                  │
   │                  └──► COMPENSATING ──► COMPENSATED           (rollback OK)
   │                                │
   │                                └──► COMPENSATION_FAILED      (manual intervention)
   │
   └──► FAILED                                                    (no compensation needed)

isTerminal returns true for states that the engine and watchdog must never advance further on their own.

Entries

STARTED

Initial state. Local saga and its first step were just recorded.

AWAITING_RESPONSE

Saga is parked waiting for an external feedback event correlated by sagaId (Saga Log Correlation). Watched by SagaWatchdog, which fails the saga if it stays here longer than veds.saga.await-response-timeout.

COMPLETED

Terminal — saga succeeded end-to-end.

FAILED

Terminal — saga failed and was not eligible for compensation.

COMPENSATING

Compensation in progress. SagaCompensationRunner is iterating previously-completed steps in reverse order, undoing each one via SagaCompensator.

COMPENSATED

Terminal — every step was successfully compensated.

COMPENSATION_FAILED

Terminal — at least one step refused to compensate. SagaWatchdog will retry compensation after veds.saga.compensation-retry-cooldown.

Properties

entries

val entries: EnumEntries<SagaStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

isTerminal

fun isTerminal(): Boolean

True when the engine must not perform any further automatic transitions on this saga.

valueOf

fun valueOf(value: String): SagaStatus

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

values

fun values(): Array<SagaStatus>

Returns an array containing the constants of this enum type, in the order they're declared.