io.simplesource.saga.client.api

Class KafkaSagaAPI<A>

java.lang.Object

io.simplesource.saga.client.api.KafkaSagaAPI<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 Implemented Interfaces:

SagaAPI<A>

public final class KafkaSagaAPI<A>
extends Object
implements SagaAPI<A>

The KafkaSagaAPI is an implementation of the SagaAPI.

This provides a mechanism to invoke a saga from any Java code, and receive the saga response asynchronously.

The client can be hosted in a separate process. It only needs to be able to access the same cluster as the SagaApp is running on, and share the same serdes for the saga request and response topics.

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.

Methods inherited from class java.lang.Object

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

Method Detail

submitSaga

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

Description copied from interface: SagaAPI

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.

Specified by:

submitSaga in interface SagaAPI<A>

Parameters:

request - the request

Returns:

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

getSagaResponse

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

Description copied from interface: SagaAPI

Returns the result of the saga.

Specified by:

getSagaResponse in interface SagaAPI<A>

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