io.simplesource.saga.model.action

Class SagaAction<A>

java.lang.Object

io.simplesource.saga.model.action.SagaAction<A>

Type Parameters:

A - a representation of an action command that is shared across all actions in the saga. This is typically a generic type, such as Json, or if using Avro serialization, SpecificRecord or GenericRecord

public class SagaAction<A>
extends Object

The representation of an action within a Saga

Field Summary

Fields

Modifier and Type	Field and Description
ActionId	actionId The Action id uniquely identifies the action within the Saga dependency graph.
ActionCommand<A>	command The action command for regular processing of the action.
Set<ActionId>	dependencies The set dependencies of an action (i.e.
List<SagaError>	error A list of error may have occurred while processing an action.
int	retryCount Th number of times that processing of an action has been re-attempted.
ActionStatus	status The status of the action.
Optional<ActionCommand<A>>	undoCommand The command for processing of the action when in undo (compensation) mode.

Constructor Summary

Constructors

Constructor and Description
SagaAction()

Method Summary

Modifier and Type	Method and Description
SagaAction<A>	updated(ActionStatus newStatus) Returns an new SagaAction with just the status updated

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

actionId

public final ActionId actionId

The Action id uniquely identifies the action within the Saga dependency graph.

command

public final ActionCommand<A> command

The action command for regular processing of the action.

undoCommand

public final Optional<ActionCommand<A>> undoCommand

The command for processing of the action when in undo (compensation) mode.

undoCommand can be defined statically as part of the initial saga definition, and can be (re)defined dynamically by the returning a new undo command from the action processor when processing in regular mode.

dependencies

public final Set<ActionId> dependencies

The set dependencies of an action (i.e. all the actions that must have completed before processing of this action can commence).

status

public final ActionStatus status

The status of the action.

error

public final List<SagaError> error

A list of error may have occurred while processing an action. Typically if ActionStatus is one of the failure status, this list will be populated with the errors that occurred.

retryCount

public final int retryCount

Th number of times that processing of an action has been re-attempted.

Constructor Detail

SagaAction

public SagaAction()

Method Detail

updated

public SagaAction<A> updated(ActionStatus newStatus)

Returns an new SagaAction with just the status updated

Parameters:

newStatus - the new status

Returns:

the saga action