io.simplesource.saga.model.api

Interface SagaAPI<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

All Known Implementing Classes:

KafkaSagaAPI

public interface SagaAPI<A>

The Saga API, used for submitting saga requests and asynchronously waiting for the result of the saga execution/

Method Summary

Modifier and Type	Method and Description
io.simplesource.data.FutureResult<SagaError,SagaResponse>	getSagaResponse(SagaId sagaId, java.time.Duration timeout) Returns the result of the saga.
io.simplesource.data.FutureResult<SagaError,SagaId>	submitSaga(SagaRequest<A> request) Initiates a saga.

Method Detail

submitSaga

io.simplesource.data.FutureResult<SagaError,SagaId> submitSaga(SagaRequest<A> request)

Initiates a saga.

This does not return the result of the saga, just an indication of whether the request was published successfully or not. We call the getSagaResponse method to asychronously return the result of the saga.

Parameters:

request - the request

Returns:

a future result with the saga Id, or an error if the saga request was not successfully published

getSagaResponse

io.simplesource.data.FutureResult<SagaError,SagaResponse> getSagaResponse(SagaId sagaId,
                                                                          java.time.Duration timeout)

Returns the result of the saga.

Parameters:

sagaId - the saga id for the saga initiated by calling submitSaga.

timeout - the timeout

Returns:

a future result with the saga response, or an error if the saga was not successfully processed