cn.leancloud.kafka.consumer

Class RetriableConsumerRecordHandler<K,V>

java.lang.Object

cn.leancloud.kafka.consumer.RetriableConsumerRecordHandler<K,V>

Type Parameters:

K - the type of key for records consumed from Kafka

V - the type of value for records consumed from Kafka

All Implemented Interfaces:

ConsumerRecordHandler<K,V>

public final class RetriableConsumerRecordHandler<K,V>
extends Object
implements ConsumerRecordHandler<K,V>

A wrapper over a ConsumerRecordHandler to let the wrapped ConsumerRecordHandler try to handle a record in a limited times in case the handling process failed.

Constructor Summary

Constructors

Constructor and Description
RetriableConsumerRecordHandler(ConsumerRecordHandler<K,V> wrappedHandler, int maxRetryTimes) Constructor for RetriableConsumerRecordHandler with max retry times limit.
RetriableConsumerRecordHandler(ConsumerRecordHandler<K,V> wrappedHandler, int maxRetryTimes, Duration retryInterval) Constructor for RetriableConsumerRecordHandler with max retry times limit and retry interval.

Method Summary

Modifier and Type	Method and Description
void	handleRecord(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> record) Handle a ConsumerRecord consumed from Kafka broker.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetriableConsumerRecordHandler

public RetriableConsumerRecordHandler(ConsumerRecordHandler<K,V> wrappedHandler,
                                      int maxRetryTimes)

Constructor for RetriableConsumerRecordHandler with max retry times limit. The returned RetriableConsumerRecordHandler is a ConsumerRecordHandler which will retry to handle a ConsumerRecord automatically if it was failed, until the ConsumerRecord was handled successfully or retried times exceeded maxRetryTimes after which a HandleMessageFailedException will be thrown.

Parameters:

wrappedHandler - the wrapped ConsumerRecordHandler.

maxRetryTimes - maximum retry times.

Throws:

NullPointerException - when wrappedHandler is null

IllegalArgumentException - if maxRetryTimes is a negative value

RetriableConsumerRecordHandler

public RetriableConsumerRecordHandler(ConsumerRecordHandler<K,V> wrappedHandler,
                                      int maxRetryTimes,
                                      Duration retryInterval)

Constructor for RetriableConsumerRecordHandler with max retry times limit and retry interval. The returned RetriableConsumerRecordHandler is a ConsumerRecordHandler which will retry to handle a ConsumerRecord automatically if it was failed, until the ConsumerRecord was handled successfully or retried times exceeded maxRetryTimes after which a HandleMessageFailedException will be thrown.

Parameters:

wrappedHandler - the wrapped ConsumerRecordHandler.

maxRetryTimes - maximum retry times.

retryInterval - the interval between every retry

Throws:

NullPointerException - when wrappedHandler or retryInterval is null

IllegalArgumentException - if maxRetryTimes is a negative value or retryInterval is a negative duration

Method Detail

handleRecord

public void handleRecord(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> record)

Description copied from interface: ConsumerRecordHandler

Handle a ConsumerRecord consumed from Kafka broker.

For the sake of fail fast, if any exception throws from this method, the thread for fetching records from Kafka broker will exit with an error message. This will trigger rebalances of partitions among all the consumer groups this consumer joined and let other consumer try to handle the failed and the following records.

You can consider to use RetriableConsumerRecordHandler to retry handling process automatically. Or use CatchAllExceptionConsumerRecordHandler as a safety net to handle all the failed records in the same way.

Specified by:

handleRecord in interface ConsumerRecordHandler<K,V>

Parameters:

record - the consumed ConsumerRecord