TopologyProvider

The main interface to provide the Topology to be executed

The concept of Topology is not specific to Azkarra but is fundamental in the implementation of a Kafka Streams application. A Topology is an object that is part of the public Kafka Streams API and allows you to define all the operations (i.e stateless or stateful) to be performed on one or more input Kafka topics.

1 The TopologyProvider interface

In Azkarra Streams, a Topology object must be defined and provided through the implementation of the TopologyProvider interface.

Here is a simple example :

    public class WordCountTopology implements TopologyProvider {

        @Override
        public Topology topology() {                       
            StreamsBuilder builder = new StreamsBuilder();
            KStream<String, String> textLines = 
                          builder.stream("streams-plaintext-input");

            textLines
                .flatMapValues(value ->
                    Arrays.asList(value.toLowerCase().split("\\W+"))
                )
                .groupBy((key, value) -> value)
                .count(Materialized.as("WordCount"))
                .toStream()
                .to(
                   "streams-wordcount-output",
                   Produced.with(Serdes.String(), Serdes.Long())
                );
            return builder.build();
        }

        @Override
        public String version() {
            return "1.0";
        }
    }

One of the specificities of Azkarra is that the TopologyProvider interface requires you to provide a non-null topology version. Usually, you will return the version of your project (e.g: 1.0, 1.2-SNAPSHOT, etc).

Last modified September 26, 2020: docs(site): fix typo and code samples (66659f7)