Package io.debezium.heartbeat

Class HeartbeatImpl

java.lang.Object

io.debezium.heartbeat.HeartbeatImpl

All Implemented Interfaces:

Heartbeat, Heartbeat.ScheduledHeartbeat, AutoCloseable

public class HeartbeatImpl
extends Object
implements Heartbeat.ScheduledHeartbeat, Heartbeat

Default implementation of Heartbeat

Nested Class Summary

Nested classes/interfaces inherited from interface io.debezium.heartbeat.Heartbeat

Heartbeat.OffsetProducer, Heartbeat.ScheduledHeartbeat

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	DEFAULT_HEARTBEAT_INTERVAL	Default length of interval in which connector generates periodically heartbeat messages.
(package private) static final String	DEFAULT_HEARTBEAT_TOPICS_PREFIX	Default prefix for names of heartbeat topics
private final Duration	heartbeatInterval
private io.debezium.util.Threads.Timer	heartbeatTimeout
private final String	key
private final org.apache.kafka.connect.data.Schema	keySchema
private static final org.slf4j.Logger	LOGGER
private final ChangeEventQueue<DataChangeEvent>	queue
static final String	SERVER_NAME_KEY
private final org.apache.kafka.connect.data.Struct	serverNameKey
private final String	topicName
private final org.apache.kafka.connect.data.Schema	valueSchema

Fields inherited from interface io.debezium.heartbeat.Heartbeat

DEFAULT_NOOP_HEARTBEAT, HEARTBEAT_INTERVAL, HEARTBEAT_INTERVAL_PROPERTY_NAME, HEARTBEAT_TOPICS_PREFIX

Fields inherited from interface io.debezium.heartbeat.Heartbeat.ScheduledHeartbeat

NOOP_HEARTBEAT

Constructor Summary

Constructors

Constructor	Description
HeartbeatImpl(Duration heartbeatInterval, String topicName, String key, SchemaNameAdjuster schemaNameAdjuster)
HeartbeatImpl(Duration heartbeatInterval, String topicName, String key, SchemaNameAdjuster schemaNameAdjuster, ChangeEventQueue<DataChangeEvent> queue)

Method Summary

Modifier and Type	Method	Description
void	emit(Map<String,?> partition, OffsetContext offset)	Generates a heartbeat record unconditionally
void	emitWithDelay(Map<String,?> partition, OffsetContext offset)	Generates a heartbeat record if defined time has elapsed
boolean	expired()
void	forcedBeat(Map<String,?> partition, Map<String,?> offset, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)	Generates a heartbeat record unconditionally Replaced by Heartbeat.emit(Map, OffsetContext)
void	heartbeat(Map<String,?> partition, Heartbeat.OffsetProducer offsetProducer, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)	Generates a heartbeat record if defined time has elapsed Replaced by Heartbeat.ScheduledHeartbeat.emitWithDelay(Map, OffsetContext)
void	heartbeat(Map<String,?> partition, Map<String,?> offset, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)	Generates a heartbeat record if defined time has elapsed Replaced by Heartbeat.ScheduledHeartbeat.emitWithDelay(Map, OffsetContext)
private org.apache.kafka.connect.source.SourceRecord	heartbeatRecord(Map<String,?> sourcePartition, Map<String,?> sourceOffset)	Produce an empty record to the heartbeat topic.
boolean	isEnabled()	Whether heartbeats are enabled or not.
private org.apache.kafka.connect.data.Struct	messageValue()	Produce a value struct containing the timestamp
void	reset()	reset the timer for the heartbeat
private io.debezium.util.Threads.Timer	resetHeartbeat()
private org.apache.kafka.connect.data.Struct	serverNameKey()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.debezium.heartbeat.Heartbeat

close

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

DEFAULT_HEARTBEAT_INTERVAL

static final int DEFAULT_HEARTBEAT_INTERVAL

Default length of interval in which connector generates periodically heartbeat messages. A size of 0 disables heartbeat.

See Also:

• Constant Field Values

DEFAULT_HEARTBEAT_TOPICS_PREFIX

static final String DEFAULT_HEARTBEAT_TOPICS_PREFIX

Default prefix for names of heartbeat topics

See Also:

• Constant Field Values

SERVER_NAME_KEY

public static final String SERVER_NAME_KEY

See Also:

• Constant Field Values

topicName

private final String topicName

heartbeatInterval

private final Duration heartbeatInterval

key

private final String key

keySchema

private final org.apache.kafka.connect.data.Schema keySchema

valueSchema

private final org.apache.kafka.connect.data.Schema valueSchema

serverNameKey

private final org.apache.kafka.connect.data.Struct serverNameKey

queue

private final ChangeEventQueue<DataChangeEvent> queue

heartbeatTimeout

private volatile io.debezium.util.Threads.Timer heartbeatTimeout

Constructor Details

HeartbeatImpl

public HeartbeatImpl(Duration heartbeatInterval,
 String topicName,
 String key,
 SchemaNameAdjuster schemaNameAdjuster)

HeartbeatImpl

public HeartbeatImpl(Duration heartbeatInterval,
 String topicName,
 String key,
 SchemaNameAdjuster schemaNameAdjuster,
 ChangeEventQueue<DataChangeEvent> queue)

Method Details

heartbeat

public void heartbeat(Map<String,?> partition,
 Map<String,?> offset,
 BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
               throws InterruptedException

Description copied from interface: Heartbeat

Generates a heartbeat record if defined time has elapsed Replaced by Heartbeat.ScheduledHeartbeat.emitWithDelay(Map, OffsetContext)

Specified by:

heartbeat in interface Heartbeat

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

heartbeat

public void heartbeat(Map<String,?> partition,
 Heartbeat.OffsetProducer offsetProducer,
 BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
               throws InterruptedException

Description copied from interface: Heartbeat

Generates a heartbeat record if defined time has elapsed Replaced by Heartbeat.ScheduledHeartbeat.emitWithDelay(Map, OffsetContext)

Specified by:

heartbeat in interface Heartbeat

Parameters:

partition - partition for the heartbeat record

offsetProducer - lazily calculated offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

forcedBeat

public void forcedBeat(Map<String,?> partition,
 Map<String,?> offset,
 BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
                throws InterruptedException

Description copied from interface: Heartbeat

Generates a heartbeat record unconditionally Replaced by Heartbeat.emit(Map, OffsetContext)

Specified by:

forcedBeat in interface Heartbeat

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

emitWithDelay

public void emitWithDelay(Map<String,?> partition,
 OffsetContext offset)
                   throws InterruptedException

Description copied from interface: Heartbeat.ScheduledHeartbeat

Generates a heartbeat record if defined time has elapsed

Specified by:

emitWithDelay in interface Heartbeat.ScheduledHeartbeat

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

Throws:

InterruptedException

expired

public boolean expired()

Specified by:

expired in interface Heartbeat.ScheduledHeartbeat

Returns:

if the timeout for the scheduled heartbeat is expired

reset

public void reset()

Description copied from interface: Heartbeat.ScheduledHeartbeat

reset the timer for the heartbeat

Specified by:

reset in interface Heartbeat.ScheduledHeartbeat

emit

public void emit(Map<String,?> partition,
 OffsetContext offset)
          throws InterruptedException

Description copied from interface: Heartbeat

Generates a heartbeat record unconditionally

Specified by:

emit in interface Heartbeat

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

Throws:

InterruptedException

isEnabled

public boolean isEnabled()

Description copied from interface: Heartbeat

Whether heartbeats are enabled or not.

Specified by:

isEnabled in interface Heartbeat

serverNameKey

private org.apache.kafka.connect.data.Struct serverNameKey()

messageValue

private org.apache.kafka.connect.data.Struct messageValue()

Produce a value struct containing the timestamp

heartbeatRecord

private org.apache.kafka.connect.source.SourceRecord heartbeatRecord(Map<String,?> sourcePartition,
 Map<String,?> sourceOffset)

Produce an empty record to the heartbeat topic.

resetHeartbeat

private io.debezium.util.Threads.Timer resetHeartbeat()