Package org.springframework.kafka.retrytopic

Class DeadLetterPublishingRecovererFactory

java.lang.Object

org.springframework.kafka.retrytopic.DeadLetterPublishingRecovererFactory

public class DeadLetterPublishingRecovererFactory
extends Object

Creates and configures the DeadLetterPublishingRecoverer that will be used to forward the messages using the DestinationTopicResolver.

Since:

2.7

Author:

Tomaz Fernandes, Gary Russell

Constructor Summary

Constructors

Constructor	Description
DeadLetterPublishingRecovererFactory(DestinationTopicResolver destinationTopicResolver)

Method Summary

Modifier and Type	Method	Description
final void	addNotRetryableException(Class<? extends Exception> exceptionType)	Add exception type to the default list.
DeadLetterPublishingRecoverer	create()
boolean	removeNotRetryableException(Class<? extends Exception> exceptionType)	Remove an exception type from the configured list.
protected org.apache.kafka.common.TopicPartition	resolveTopicPartition(org.apache.kafka.clients.consumer.ConsumerRecord<?,?> cr, DestinationTopic nextDestination)	Creates and returns the TopicPartition, where the original record should be forwarded.
void	setDeadLetterPublishingRecovererCustomizer(Consumer<DeadLetterPublishingRecoverer> customizer)

Methods inherited from class java.lang.Object

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

Constructor Details

DeadLetterPublishingRecovererFactory

public DeadLetterPublishingRecovererFactory(DestinationTopicResolver destinationTopicResolver)

Method Details

addNotRetryableException

public final void addNotRetryableException(Class<? extends Exception> exceptionType)

Add exception type to the default list. By default, the following exceptions will not be retried:

• DeserializationException
• MessageConversionException
• ConversionException
• MethodArgumentResolutionException
• NoSuchMethodException
• ClassCastException

All others will be retried.

Parameters:

exceptionType - the exception type.

Since:

2.8

See Also:

• removeNotRetryableException(Class)

removeNotRetryableException

public boolean removeNotRetryableException(Class<? extends Exception> exceptionType)

Remove an exception type from the configured list. By default, the following exceptions will not be retried:

• DeserializationException
• MessageConversionException
• ConversionException
• MethodArgumentResolutionException
• NoSuchMethodException
• ClassCastException

All others will be retried.

Parameters:

exceptionType - the exception type.

Returns:

true if the removal was successful.

See Also:

• addNotRetryableException(Class)

create

public DeadLetterPublishingRecoverer create()

setDeadLetterPublishingRecovererCustomizer

public void setDeadLetterPublishingRecovererCustomizer(Consumer<DeadLetterPublishingRecoverer> customizer)

resolveTopicPartition

protected org.apache.kafka.common.TopicPartition resolveTopicPartition(org.apache.kafka.clients.consumer.ConsumerRecord<?,?> cr,
 DestinationTopic nextDestination)

Creates and returns the TopicPartition, where the original record should be forwarded. By default, it will use the partition same as original record's partition, in the next destination topic.

DeadLetterPublishingRecoverer.checkPartition(org.apache.kafka.common.TopicPartition, org.apache.kafka.clients.consumer.Consumer<?, ?>) has logic to check whether that partition exists, and if it doesn't it sets -1, to allow the Producer itself to assign a partition to the record.

Subclasses can inherit from this method to override the implementation, if necessary.

Parameters:

cr - The original ConsumerRecord, which is to be forwarded to DLT

nextDestination - The next DestinationTopic, where the consumerRecord is to be forwarded

Returns:

An instance of TopicPartition, specifying the topic and partition, where the cr is to be sent