Package com.bakdata.kafka.streams

Interface StreamsApp

All Superinterfaces:

App<StreamsTopicConfig,StreamsCleanUpConfiguration>, AutoCloseable

All Known Subinterfaces:

LargeMessageStreamsApp

public interface StreamsApp
extends App<StreamsTopicConfig,StreamsCleanUpConfiguration>

Application that defines a Kafka Streams Topology and necessary configurations

Method Summary

Modifier and Type	Method	Description
void	buildTopology(StreamsBuilderX builder)	Build the Kafka Streams Topology to be run by the app.
SerdeConfig	defaultSerializationConfig()	Configure default serialization behavior
default String	getUniqueAppId(StreamsAppConfiguration configuration)	This must be set to a unique value for every application interacting with your Kafka cluster to ensure internal state encapsulation.
default StreamsCleanUpConfiguration	setupCleanUp(AppConfiguration<StreamsTopicConfig> configuration)	Configure clean up behavior

Methods inherited from interface com.bakdata.kafka.App

close, createKafkaProperties, setup

Method Details

buildTopology

void buildTopology(StreamsBuilderX builder)

Build the Kafka Streams Topology to be run by the app.

Parameters:

builder - provides all runtime application configurations and supports building the Topology

getUniqueAppId

default String getUniqueAppId(StreamsAppConfiguration configuration)

This must be set to a unique value for every application interacting with your Kafka cluster to ensure internal state encapsulation. Could be set to: className-outputTopic.

User may provide a unique application identifier via StreamsAppConfiguration.getUniqueAppId(). If that is the case, the returned application ID should match the provided one.

Parameters:

configuration - provides runtime configuration

Returns:

unique application identifier

setupCleanUp

default StreamsCleanUpConfiguration setupCleanUp(AppConfiguration<StreamsTopicConfig> configuration)

Description copied from interface: App

Configure clean up behavior

Specified by:

setupCleanUp in interface App<StreamsTopicConfig,StreamsCleanUpConfiguration>

Parameters:

configuration - provides all runtime application configurations

Returns:

StreamsCleanUpConfiguration

See Also:

• StreamsCleanUpRunner

defaultSerializationConfig

SerdeConfig defaultSerializationConfig()

Description copied from interface: App

Configure default serialization behavior

Specified by:

defaultSerializationConfig in interface App<StreamsTopicConfig,StreamsCleanUpConfiguration>

Returns:

SerializationConfig