io.simplesource.saga.model.action

Enum ActionStatus

java.lang.Object

java.lang.Enum<ActionStatus>

io.simplesource.saga.model.action.ActionStatus

All Implemented Interfaces:

Serializable, Comparable<ActionStatus>

public enum ActionStatus
extends Enum<ActionStatus>

An enum representing the current state of an action within a saga

See Also:

SagaStatus

Enum Constant Summary

Enum Constants

Enum Constant and Description
Completed Action has completed successfully, and an action response has been received.
Failed Action has failed to complete, possibly after one or more retries.
InProgress An action request has been published to start action, but no response has been received.
Pending The initial state of action, before execution of the action has started.
RetryAwaiting Action has failed to complete, and a retry has been scheduled to attempt processing again after a certain delay.
RetryCompleted A transient state which indicates that the waiting period of a retry has completed, and reprocessing can commence.
UndoBypassed Action does not have an undo command, so when processing backwards in undo (compensation) mode, processing for this action is bypassed.
UndoFailed Undo command for this action has failed to complete, possibly after one or more retries.
UndoInProgress One of the other saga actions has failed, and a request has been published to undo this action, but no response has been received.
Undone Undo command for this action has completed successfully.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Pending

public static final ActionStatus Pending

The initial state of action, before execution of the action has started.

InProgress

public static final ActionStatus InProgress

An action request has been published to start action, but no response has been received.

Completed

public static final ActionStatus Completed

Action has completed successfully, and an action response has been received.

Failed

public static final ActionStatus Failed

Action has failed to complete, possibly after one or more retries.

UndoInProgress

public static final ActionStatus UndoInProgress

One of the other saga actions has failed, and a request has been published to undo this action, but no response has been received.

Undone

public static final ActionStatus Undone

Undo command for this action has completed successfully.

UndoBypassed

public static final ActionStatus UndoBypassed

Action does not have an undo command, so when processing backwards in undo (compensation) mode, processing for this action is bypassed.

UndoFailed

public static final ActionStatus UndoFailed

Undo command for this action has failed to complete, possibly after one or more retries.

RetryAwaiting

public static final ActionStatus RetryAwaiting

Action has failed to complete, and a retry has been scheduled to attempt processing again after a certain delay.

RetryCompleted

public static final ActionStatus RetryCompleted

A transient state which indicates that the waiting period of a retry has completed, and reprocessing can commence.

Method Detail

values

public static ActionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ActionStatus c : ActionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static ActionStatus valueOf(String name)

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null