io.simplesource.saga.model.action

Class ActionCommand<A>

java.lang.Object

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

An ActionCommand is a data class with the information needed:

• to uniquely identify the execution of the action and know whether it has been processed or not.
• to determine which action processor to use to process an action.
• by the action processor to process the action.

Field Summary

Fields

Modifier and Type	Field and Description
String	actionType Every action processor has an associated action type.
A	command An action command, expressed in a generic type A, that the action processor is able to decode.
io.simplesource.api.CommandId	commandId The command Id is the unique identifier for an action command.

Constructor Summary

Constructors

Constructor and Description
ActionCommand()

Method Summary

Modifier and Type	Method and Description
static <A> ActionCommand<A>	of(A command, String actionType) Static constructor for action commands

Methods inherited from class java.lang.Object

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

Field Detail

commandId

public final io.simplesource.api.CommandId commandId

The command Id is the unique identifier for an action command. Actions should be idempotent with respect to command Id.

This means that:

• if the action processor receives an action request with a given command Id that it has already seen and processed before, it should republish the action response and do no further processing.
• if the saga coordinator retries a failed action, it will republish the action request with a different command Id.
• the undo action has a distinct command Id from the original action.

command

public final A command

An action command, expressed in a generic type A, that the action processor is able to decode.

actionType

public final String actionType

Every action processor has an associated action type. This action type identifies which action processor to use to process an action. It also specifies which topics to use for action requests and responses.

Constructor Detail

ActionCommand

public ActionCommand()

Method Detail

of

public static <A> ActionCommand<A> of(A command,
                                      String actionType)

Static constructor for action commands

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

Parameters:

command - the action command, expressed in a generic type A, that the action processor is able to decode

actionType - the action type, which determines which action processor is used to process the action

Returns:

the action command