io.simplesource.saga.client.api

Class SagaClientBuilder<A>

java.lang.Object

io.simplesource.saga.client.api.SagaClientBuilder<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 final class SagaClientBuilder<A>
extends Object

The saga client builder is used to create a SagaAPI.

To create an instance of a SagaAPI, use code like this:

 SagaAPI<A> sagaApi = SagaClientBuilder
     .create(a -> a.withBootstrapServers("kafka_broker:9092"))
     .withSerdes(serdes)
     .withClientId(clientId)
     .withScheduler(scheduler)
     .build();
 

Constructor Summary

Constructors

Constructor and Description
SagaClientBuilder()

Method Summary

Modifier and Type	Method and Description
SagaAPI<A>	build() Builds the saga API.
static <A> SagaClientBuilder<A>	create() Create saga client builder.
static <A> SagaClientBuilder<A>	create(PropertiesBuilder.BuildSteps configBuildSteps) Create saga client builder with config properties.
SagaClientBuilder<A>	withClientId(String clientId) With client id saga client builder.
SagaClientBuilder<A>	withProperties(PropertiesBuilder.BuildSteps configBuildSteps) Sets the config properties.
SagaClientBuilder<A>	withScheduler(ScheduledExecutorService scheduler) Sets the scheduler required to schedule timeouts.
SagaClientBuilder<A>	withSerdes(SagaClientSerdes<A> serdes) Sets the Serdes required for the saga request and saga response topics.
SagaClientBuilder<A>	withTopicConfig(TopicConfigBuilder.BuildSteps topicBuildFn) Sets the topic configuration for naming and creating the saga request and response topics.

Methods inherited from class java.lang.Object

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

Constructor Detail

SagaClientBuilder

public SagaClientBuilder()

Method Detail

create

public static <A> SagaClientBuilder<A> create()

Create saga client builder.

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

Returns:

the saga client builder

create

public static <A> SagaClientBuilder<A> create(PropertiesBuilder.BuildSteps configBuildSteps)

Create saga client builder with config properties.

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:

configBuildSteps - a function that allows setting Kafka config properties incrementally.

Returns:

the saga client builder

withProperties

public SagaClientBuilder<A> withProperties(PropertiesBuilder.BuildSteps configBuildSteps)

Sets the config properties.

Parameters:

configBuildSteps - a sequence of configuration steps

Returns:

the saga client builder

withSerdes

public SagaClientBuilder<A> withSerdes(SagaClientSerdes<A> serdes)

Sets the Serdes required for the saga request and saga response topics.

Parameters:

serdes - the serdes for the action

Returns:

the saga client builder

withScheduler

public SagaClientBuilder<A> withScheduler(ScheduledExecutorService scheduler)

Sets the scheduler required to schedule timeouts.

Parameters:

scheduler - the scheduler

Returns:

the saga client builder

withTopicConfig

public SagaClientBuilder<A> withTopicConfig(TopicConfigBuilder.BuildSteps topicBuildFn)

Sets the topic configuration for naming and creating the saga request and response topics.

Parameters:

topicBuildFn - a function to set topic configuration details incrementally.

Returns:

the saga client builder

withClientId

public SagaClientBuilder<A> withClientId(String clientId)

With client id saga client builder.

Parameters:

clientId - the client id

Returns:

the saga client builder

build

public SagaAPI<A> build()

Builds the saga API.

Returns:

the saga API