Package io.debezium.pipeline.signal.channels

Class KafkaSignalChannel

java.lang.Object

io.debezium.pipeline.signal.channels.KafkaSignalChannel

All Implemented Interfaces:

SignalChannelReader

public class KafkaSignalChannel
extends Object
implements SignalChannelReader

The class responsible for processing of signals delivered to Debezium via a dedicated Kafka topic. The signal message must have the following structure:

• id STRING - the unique identifier of the signal sent, usually UUID, can be used for deduplication
• type STRING - the unique logical name of the code executing the signal
• data STRING - the data in JSON format that are passed to the signal code

Field Summary

Fields

Modifier and Type	Field	Description
private static final io.debezium.config.Field.Set	ALL_FIELDS
static final io.debezium.config.Field	BOOTSTRAP_SERVERS
static final String	CHANNEL_NAME
static final String	CHANNEL_OFFSET
static final String	CONFIGURATION_FIELD_PREFIX_STRING
private String	connectorName
private static final String	CONSUMER_PREFIX
static final io.debezium.config.Field	GROUP_ID
private static final org.slf4j.Logger	LOGGER
private Duration	pollTimeoutMs
static final io.debezium.config.Field	SIGNAL_POLL_TIMEOUT_MS
static final io.debezium.config.Field	SIGNAL_TOPIC
private org.apache.kafka.clients.consumer.KafkaConsumer<String,String>	signalsConsumer
private String	topicName

Constructor Summary

Constructors

Constructor	Description
KafkaSignalChannel()

Method Summary

Modifier and Type	Method	Description
private static io.debezium.config.Configuration	buildKafkaConfiguration(io.debezium.config.Configuration signalConfig)
void	close()
void	init(CommonConnectorConfig connectorConfig)
String	name()
private static Optional<Document>	parseJson(String value)
private Optional<SignalRecord>	processSignal(org.apache.kafka.clients.consumer.ConsumerRecord<String,String> record)
List<SignalRecord>	read()
void	seek(long signalOffset)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.debezium.pipeline.signal.channels.SignalChannelReader

reset

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

CONFIGURATION_FIELD_PREFIX_STRING

public static final String CONFIGURATION_FIELD_PREFIX_STRING

See Also:

• Constant Field Values

CONSUMER_PREFIX

private static final String CONSUMER_PREFIX

See Also:

• Constant Field Values

CHANNEL_OFFSET

public static final String CHANNEL_OFFSET

See Also:

• Constant Field Values

CHANNEL_NAME

public static final String CHANNEL_NAME

See Also:

• Constant Field Values

topicName

private String topicName

connectorName

private String connectorName

pollTimeoutMs

private Duration pollTimeoutMs

signalsConsumer

private org.apache.kafka.clients.consumer.KafkaConsumer<String,String> signalsConsumer

SIGNAL_TOPIC

public static final io.debezium.config.Field SIGNAL_TOPIC

BOOTSTRAP_SERVERS

public static final io.debezium.config.Field BOOTSTRAP_SERVERS

SIGNAL_POLL_TIMEOUT_MS

public static final io.debezium.config.Field SIGNAL_POLL_TIMEOUT_MS

GROUP_ID

public static final io.debezium.config.Field GROUP_ID

ALL_FIELDS

private static final io.debezium.config.Field.Set ALL_FIELDS

Constructor Details

KafkaSignalChannel

public KafkaSignalChannel()

Method Details

processSignal

private Optional<SignalRecord> processSignal(org.apache.kafka.clients.consumer.ConsumerRecord<String,String> record)

parseJson

private static Optional<Document> parseJson(String value)

seek

public void seek(long signalOffset)

name

public String name()

Specified by:

name in interface SignalChannelReader

init

public void init(CommonConnectorConfig connectorConfig)

Specified by:

init in interface SignalChannelReader

buildKafkaConfiguration

private static io.debezium.config.Configuration buildKafkaConfiguration(io.debezium.config.Configuration signalConfig)

read

public List<SignalRecord> read()

Specified by:

read in interface SignalChannelReader

close

public void close()

Specified by:

close in interface SignalChannelReader