Enum Class SagaStepState

java.lang.Object

java.lang.Enum<SagaStepState>

org.j7m.middleware.api.saga.SagaStepState

All Implemented Interfaces:

Serializable, Comparable<SagaStepState>, Constable

public enum SagaStepState
extends Enum<SagaStepState>

Durable saga step lifecycle state.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	Step was cancelled by policy.
COMPENSATED	Step compensation succeeded.
COMPENSATING	Step compensation is running.
COMPENSATION_FAILED	Step compensation failed and may retry or dead-letter.
DEAD_LETTERED	Step or compensation failure was moved to durable dead-letter state.
FAILED	Step action failed.
PENDING	Step has not started.
RETRY_PENDING	Step is waiting for deterministic retry eligibility.
RUNNING	Step action is running.
SKIPPED	Step was skipped by policy after cancellation or failure.
SUCCEEDED	Step action succeeded and may be compensated later if needed.
TIMED_OUT	Step exceeded its step timeout.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final SagaStepState PENDING

Step has not started.

RUNNING

public static final SagaStepState RUNNING

Step action is running.

SUCCEEDED

public static final SagaStepState SUCCEEDED

Step action succeeded and may be compensated later if needed.

FAILED

public static final SagaStepState FAILED

Step action failed.

RETRY_PENDING

public static final SagaStepState RETRY_PENDING

Step is waiting for deterministic retry eligibility.

COMPENSATING

public static final SagaStepState COMPENSATING

Step compensation is running.

COMPENSATED

public static final SagaStepState COMPENSATED

Step compensation succeeded.

COMPENSATION_FAILED

public static final SagaStepState COMPENSATION_FAILED

Step compensation failed and may retry or dead-letter.

DEAD_LETTERED

public static final SagaStepState DEAD_LETTERED

Step or compensation failure was moved to durable dead-letter state.

SKIPPED

public static final SagaStepState SKIPPED

Step was skipped by policy after cancellation or failure.

CANCELLED

public static final SagaStepState CANCELLED

Step was cancelled by policy.

TIMED_OUT

public static final SagaStepState TIMED_OUT

Step exceeded its step timeout.

Method Details

values

public static SagaStepState[] 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 SagaStepState 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