Package com.bakdata.kafka.producer

Class KafkaProducerApplication<T extends ProducerApp>

java.lang.Object

com.bakdata.kafka.KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T>,ConfiguredProducerApp<T>,ProducerTopicConfig,T,ProducerAppConfiguration>

com.bakdata.kafka.producer.KafkaProducerApplication<T>

Type Parameters:

T - type of ProducerApp created by this application

All Implemented Interfaces:

AutoCloseable, Runnable

Direct Known Subclasses:

SimpleKafkaProducerApplication

public abstract class KafkaProducerApplication<T extends ProducerApp>
extends KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T>,ConfiguredProducerApp<T>,ProducerTopicConfig,T,ProducerAppConfiguration>

The base class for creating Kafka Producer applications.

This class provides the following configuration options in addition to those provided by KafkaApplication:

• getOutputTopic()
• getLabeledOutputTopics()

To implement your Kafka Producer application inherit from this class and add your custom options. Run it by creating an instance of your class and calling KafkaApplication.startApplication(String[]) from your main.

Nested Class Summary

Nested classes/interfaces inherited from class com.bakdata.kafka.KafkaApplication

KafkaApplication.CleanableApp<CR extends CleanUpRunner>, KafkaApplication.RunnableApp<R extends Runner>

Constructor Summary

Constructors

Constructor	Description
KafkaProducerApplication()

Method Summary

Modifier and Type	Method	Description
void	clean()	Delete all output topics associated with the Kafka Producer application.
ProducerAppConfiguration	createConfiguration(ProducerTopicConfig topics)	Create configuration to configure app
final ConfiguredProducerApp<T>	createConfiguredApp(T app, ProducerAppConfiguration configuration)	Create a new ConfiguredApp that will be executed according to the given config.
final Optional<ProducerExecutionOptions>	createExecutionOptions()	Create options for running the app
final ProducerTopicConfig	createTopicConfig()	Topics used by app
Map<String,String>	getLabeledOutputTopics()
OutputOptions	getOutputOptions()
String	getOutputTopic()
void	setLabeledOutputTopics(Map<String,String> labeledOutputTopics)
void	setOutputOptions(OutputOptions outputOptions)
void	setOutputTopic(String outputTopic)
String	toString()

Methods inherited from class com.bakdata.kafka.KafkaApplication

close, createApp, createCleanableApp, createConfiguredApp, createExecutableApp, createRunnableApp, getBootstrapServers, getKafkaConfig, getRuntimeConfiguration, getSchemaRegistryUrl, onApplicationStart, prepareClean, prepareRun, run, setBootstrapServers, setKafkaConfig, setSchemaRegistryUrl, startApplication, startApplicationWithoutExit, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

KafkaProducerApplication

public KafkaProducerApplication()

Method Details

clean

public void clean()

Delete all output topics associated with the Kafka Producer application.

Overrides:

clean in class KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T extends ProducerApp>,ConfiguredProducerApp<T extends ProducerApp>,ProducerTopicConfig,T extends ProducerApp,ProducerAppConfiguration>

createExecutionOptions

public final Optional<ProducerExecutionOptions> createExecutionOptions()

Description copied from class: KafkaApplication

Create options for running the app

Specified by:

createExecutionOptions in class KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T extends ProducerApp>,ConfiguredProducerApp<T extends ProducerApp>,ProducerTopicConfig,T extends ProducerApp,ProducerAppConfiguration>

Returns:

run options if available

See Also:

• ExecutableApp.createRunner(Object)

createTopicConfig

public final ProducerTopicConfig createTopicConfig()

Description copied from class: KafkaApplication

Topics used by app

Specified by:

createTopicConfig in class KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T extends ProducerApp>,ConfiguredProducerApp<T extends ProducerApp>,ProducerTopicConfig,T extends ProducerApp,ProducerAppConfiguration>

Returns:

topic configuration

createConfiguredApp

public final ConfiguredProducerApp<T> createConfiguredApp(T app,
 ProducerAppConfiguration configuration)

Description copied from class: KafkaApplication

Create a new ConfiguredApp that will be executed according to the given config.

Specified by:

createConfiguredApp in class KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T extends ProducerApp>,ConfiguredProducerApp<T extends ProducerApp>,ProducerTopicConfig,T extends ProducerApp,ProducerAppConfiguration>

Parameters:

app - app to configure.

configuration - configuration for app

Returns:

ConfiguredApp

createConfiguration

public ProducerAppConfiguration createConfiguration(ProducerTopicConfig topics)

Description copied from class: KafkaApplication

Create configuration to configure app

Specified by:

createConfiguration in class KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T extends ProducerApp>,ConfiguredProducerApp<T extends ProducerApp>,ProducerTopicConfig,T extends ProducerApp,ProducerAppConfiguration>

Parameters:

topics - topic configuration

Returns:

configuration

toString

public String toString()

Overrides:

toString in class KafkaApplication<ProducerRunner,ProducerCleanUpRunner,ProducerExecutionOptions,ExecutableProducerApp<T extends ProducerApp>,ConfiguredProducerApp<T extends ProducerApp>,ProducerTopicConfig,T extends ProducerApp,ProducerAppConfiguration>

getOutputOptions

public OutputOptions getOutputOptions()

setOutputOptions

public void setOutputOptions(OutputOptions outputOptions)

getOutputTopic

public String getOutputTopic()

getLabeledOutputTopics

public Map<String,String> getLabeledOutputTopics()

setOutputTopic

public void setOutputTopic(String outputTopic)

setLabeledOutputTopics

public void setLabeledOutputTopics(Map<String,String> labeledOutputTopics)