io.simplesource.saga.model.messages

Class ActionResponse<A>

java.lang.Object

io.simplesource.saga.model.messages.ActionResponse<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 ActionResponse<A>
extends Object

An action response, published by the action processor that receive the corresponding ActionResponse in the action response topic.

The saga coordinator consumes this response and updates the action and saga state as appropriate.

The action request and response is essentially the interface between the saga coordinator and the action processor. Although the saga coordinator and action processor can be hosted in different processes, they must share the same A type, and also must have Serdes that are compatible with each other.

Field Summary

Fields

Modifier and Type	Field and Description
ActionId	actionId The action id uniquely identifies an action in the saga dependency graph.
io.simplesource.api.CommandId	commandId The command id is the unique identifier for an action command execution.
Boolean	isUndo Indicates whether or not this action is processing in undo (compensation) mode.
io.simplesource.data.Result<SagaError,Optional<UndoCommand<A>>>	result The result, consisting of a SagaError if processing fail and indicating success if processing succeeds.
SagaId	sagaId The saga id uniquely identifies the saga, and is used as the key for the action request and responses.

Constructor Summary

Constructors

Constructor and Description
ActionResponse()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

sagaId

public final SagaId sagaId

The saga id uniquely identifies the saga, and is used as the key for the action request and responses.

actionId

public final ActionId actionId

The action id uniquely identifies an action in the saga dependency graph.

commandId

public final io.simplesource.api.CommandId commandId

The command id is the unique identifier for an action command execution.

isUndo

public final Boolean isUndo

Indicates whether or not this action is processing in undo (compensation) mode.

result

public final io.simplesource.data.Result<SagaError,Optional<UndoCommand<A>>> result

The result, consisting of a SagaError if processing fail and indicating success if processing succeeds.

The action processor can optionally return an undo command for a non-undo action that processes successfully. If set, this replaces any undo command that may already be defined in the dependency graph.

Constructor Detail

ActionResponse

public ActionResponse()