io.simplesource.saga.client.dsl

Class SagaDSL.SagaBuilder<A>

java.lang.Object

io.simplesource.saga.client.dsl.SagaDSL.SagaBuilder<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

Enclosing class:

SagaDSL

public static final class SagaDSL.SagaBuilder<A>
extends Object

A SagaBuilder is used to add actions by creating a subsaga consisting of a single action, and to build the saga once the definition steps are complete.

Constructor Summary

Constructors

Constructor and Description
SagaBuilder()

Method Summary

Modifier and Type	Method and Description
SagaDSL.SubSaga<A>	addAction(ActionId actionId, String actionType, A actionCommand) Adds an action with no undo action command, creating a sub saga with a single action.
SagaDSL.SubSaga<A>	addAction(ActionId actionId, String actionType, A actionCommand, A undoActionCommand) Adds an action with an undo action command, creating a sub saga with a single action.
SagaDSL.SubSaga<A>	addAction(String actionType, A actionCommand) Adds an action with a random Id and no undo action command, creating a sub saga with a single action.
SagaDSL.SubSaga<A>	addAction(String actionType, A actionCommand, A undoActionCommand) Adds an action with a random Id and an undo action command, creating a sub saga with a single action.
io.simplesource.data.Result<SagaError,Saga<A>>	build() builds the Saga from all the subsagas that were previously defined by creating single actions with addAction and by defining the dependencies between these actions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SagaBuilder

public SagaBuilder()

Method Detail

addAction

public SagaDSL.SubSaga<A> addAction(String actionType,
                                    A actionCommand)

Adds an action with a random Id and no undo action command, creating a sub saga with a single action.

Parameters:

actionType - the action type

actionCommand - the action command

Returns:

the sub saga

addAction

public SagaDSL.SubSaga<A> addAction(String actionType,
                                    A actionCommand,
                                    A undoActionCommand)

Adds an action with a random Id and an undo action command, creating a sub saga with a single action.

Parameters:

actionType - the action type

actionCommand - the action command

undoActionCommand - the undo action command

Returns:

the sub saga

addAction

public SagaDSL.SubSaga<A> addAction(ActionId actionId,
                                    String actionType,
                                    A actionCommand)

Adds an action with no undo action command, creating a sub saga with a single action.

Parameters:

actionId - the action id

actionType - the action type

actionCommand - the action command

Returns:

the sub saga

addAction

public SagaDSL.SubSaga<A> addAction(ActionId actionId,
                                    String actionType,
                                    A actionCommand,
                                    A undoActionCommand)

Adds an action with an undo action command, creating a sub saga with a single action.

Parameters:

actionId - the action id

actionType - the action type

actionCommand - the action command

undoActionCommand - the undo action command

Returns:

the sub saga

build

public io.simplesource.data.Result<SagaError,Saga<A>> build()

builds the Saga from all the subsagas that were previously defined by creating single actions with addAction and by defining the dependencies between these actions.

The Saga returned can be considered an immutable data structure. Any mutations to saga state from this point on will result in a new instance being created.

Returns:

the result, either successful with the built Saga, or a SagaError.