io.simplesource.saga.shared.topics

Class TopicConfigBuilder

java.lang.Object

io.simplesource.saga.shared.topics.TopicConfigBuilder

public class TopicConfigBuilder
extends Object

TopicConfigBuilder, as used with TopicConfigBuilder.BuildSteps is a functional pattern for setting topic configuration Whenever a TopicConfigBuilder.BuildSteps is required, a user can provide a lambda function of this form for example:

 builder -> builder
     .withDefaultTopicSpec(partitions, replication, retentionInDays)
     .with
     .withTopicPrefix("prefix")
 *

This pattern allows the framework flexibility how it treats this configuration, without complicating the user interaction as the framework determines when the config is built.

The topic configuration covers both the topic naming conventions, as well as the configuration required to create the missing topics.

This pattern enables topics names and configurations to have sensible out the box defaults, so minimal up-front configuration is required, but still allow for complete flexibility.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TopicConfigBuilder.BuildSteps A functional interface representing a configuration step that is applied to a topic builder

Method Summary

Modifier and Type	Method and Description
TopicConfigBuilder	withDefaultTopicSpec(int partitions, int replication, int retentionInDays) Sets the topic spec by default topic to be the topic spec with the specified partitions and replication factor, as well as the setting the topic retention
TopicConfigBuilder	withNamingStrategy(io.simplesource.kafka.api.ResourceNamingStrategy namingStrategy) Sets the the resource naming strategy for topic creation
TopicConfigBuilder	withTopicBaseName(String topicBaseName) Sets the base name for topic creation when applying the prefix resource naming strategy
TopicConfigBuilder	withTopicNameOverride(String topicType, String topicName) Overrides the topic name for a given topic type
TopicConfigBuilder	withTopicNamer(TopicNamer topicNamer) Explicitly sets the topic namer
TopicConfigBuilder	withTopicPrefix(String prefix) Sets the resource naming strategy to PrefixResourceNamingStrategy with the given prefix
TopicConfigBuilder	withTopicSpecOverride(String topicType, io.simplesource.kafka.spec.TopicSpec topicSpec) Overrides the topic spec for a given topic type

Methods inherited from class java.lang.Object

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

Method Detail

withNamingStrategy

public TopicConfigBuilder withNamingStrategy(io.simplesource.kafka.api.ResourceNamingStrategy namingStrategy)

Sets the the resource naming strategy for topic creation

Parameters:

namingStrategy - the naming strategy

Returns:

the topic config builder

withTopicPrefix

public TopicConfigBuilder withTopicPrefix(String prefix)

Sets the resource naming strategy to PrefixResourceNamingStrategy with the given prefix

Parameters:

prefix - the prefix

Returns:

the topic config builder

withTopicBaseName

public TopicConfigBuilder withTopicBaseName(String topicBaseName)

Sets the base name for topic creation when applying the prefix resource naming strategy

Parameters:

topicBaseName - the topic base name

Returns:

the topic config builder

withTopicNamer

public TopicConfigBuilder withTopicNamer(TopicNamer topicNamer)

Explicitly sets the topic namer

Parameters:

topicNamer - the topic namer

Returns:

the topic config builder

withTopicNameOverride

public TopicConfigBuilder withTopicNameOverride(String topicType,
                                                String topicName)

Overrides the topic name for a given topic type

Parameters:

topicType - the topic type

topicName - the topic name

Returns:

the topic config builder

withTopicSpecOverride

public TopicConfigBuilder withTopicSpecOverride(String topicType,
                                                io.simplesource.kafka.spec.TopicSpec topicSpec)

Overrides the topic spec for a given topic type

Parameters:

topicType - the topic type

topicSpec - the topic spec

Returns:

the topic config builder

withDefaultTopicSpec

public TopicConfigBuilder withDefaultTopicSpec(int partitions,
                                               int replication,
                                               int retentionInDays)

Sets the topic spec by default topic to be the topic spec with the specified partitions and replication factor, as well as the setting the topic retention

Parameters:

partitions - the partitions

replication - the replication

retentionInDays - the retention in days

Returns:

the topic config builder