Package org.springframework.kafka.listener

Class ErrorHandlingUtils

java.lang.Object

org.springframework.kafka.listener.ErrorHandlingUtils

public final class ErrorHandlingUtils
extends java.lang.Object

Utilities for error handling.

Since:

2.8

Method Summary

Modifier and Type	Method	Description
static void	clearRetryListeners()	Clear the retry listeners.
static java.lang.String	recordsToString(org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records)	Represent the records as a comma-delimited String of topic-part@offset.
static void	retryBatch(java.lang.Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records, org.apache.kafka.clients.consumer.Consumer<?,?> consumer, MessageListenerContainer container, java.lang.Runnable invokeListener, org.springframework.util.backoff.BackOff backOff, CommonErrorHandler seeker, java.util.function.BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?,?>,java.lang.Exception> recoverer, org.springframework.core.log.LogAccessor logger, KafkaException.Level logLevel)	Deprecated. in favor of retryBatch(Exception, ConsumerRecords, Consumer, MessageListenerContainer, Runnable, BackOff, CommonErrorHandler, BiConsumer, LogAccessor, org.springframework.kafka.KafkaException.Level, List, BinaryExceptionClassifier).
static void	retryBatch(java.lang.Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records, org.apache.kafka.clients.consumer.Consumer<?,?> consumer, MessageListenerContainer container, java.lang.Runnable invokeListener, org.springframework.util.backoff.BackOff backOff, CommonErrorHandler seeker, java.util.function.BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?,?>,java.lang.Exception> recoverer, org.springframework.core.log.LogAccessor logger, KafkaException.Level logLevel, java.util.List<RetryListener> retryListenersArg, org.springframework.classify.BinaryExceptionClassifier classifier)	Retry a complete batch by pausing the consumer and then, in a loop, poll the consumer, wait for the next back off, then call the listener.
static void	setRetryListeners(java.util.List<RetryListener> listeners)	Set the retry listeners.
static java.lang.Exception	unwrapIfNeeded(java.lang.Exception exception)	Remove a TimestampedException, if present.

Methods inherited from class java.lang.Object

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

Method Detail

setRetryListeners

public static void setRetryListeners(java.util.List<RetryListener> listeners)

Set the retry listeners.

Parameters:

listeners - the listeners.

Since:

2.8.10

clearRetryListeners

public static void clearRetryListeners()

Clear the retry listeners.

Since:

2.8.10

retryBatch

@Deprecated
public static void retryBatch(java.lang.Exception thrownException,
                              org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records,
                              org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                              MessageListenerContainer container,
                              java.lang.Runnable invokeListener,
                              org.springframework.util.backoff.BackOff backOff,
                              CommonErrorHandler seeker,
                              java.util.function.BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?,?>,java.lang.Exception> recoverer,
                              org.springframework.core.log.LogAccessor logger,
                              KafkaException.Level logLevel)

Deprecated.

in favor of retryBatch(Exception, ConsumerRecords, Consumer, MessageListenerContainer, Runnable, BackOff, CommonErrorHandler, BiConsumer, LogAccessor, org.springframework.kafka.KafkaException.Level, List, BinaryExceptionClassifier).

Retry a complete batch by pausing the consumer and then, in a loop, poll the consumer, wait for the next back off, then call the listener. When retries are exhausted, call the recoverer with the ConsumerRecords.

Parameters:

thrownException - the exception.

records - the records.

consumer - the consumer.

container - the container.

invokeListener - the Runnable to run (call the listener).

backOff - the backOff.

seeker - the common error handler that re-seeks the entire batch.

recoverer - the recoverer.

logger - the logger.

logLevel - the log level.

retryBatch

public static void retryBatch(java.lang.Exception thrownException,
                              org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records,
                              org.apache.kafka.clients.consumer.Consumer<?,?> consumer,
                              MessageListenerContainer container,
                              java.lang.Runnable invokeListener,
                              org.springframework.util.backoff.BackOff backOff,
                              CommonErrorHandler seeker,
                              java.util.function.BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?,?>,java.lang.Exception> recoverer,
                              org.springframework.core.log.LogAccessor logger,
                              KafkaException.Level logLevel,
                              @Nullable
                              java.util.List<RetryListener> retryListenersArg,
                              org.springframework.classify.BinaryExceptionClassifier classifier)

Retry a complete batch by pausing the consumer and then, in a loop, poll the consumer, wait for the next back off, then call the listener. When retries are exhausted, call the recoverer with the ConsumerRecords.

Parameters:

thrownException - the exception.

records - the records.

consumer - the consumer.

container - the container.

invokeListener - the Runnable to run (call the listener).

backOff - the backOff.

seeker - the common error handler that re-seeks the entire batch.

recoverer - the recoverer.

logger - the logger.

logLevel - the log level.

retryListenersArg - the retry listeners.

classifier - the exception classifier.

Since:

2.8.11

recordsToString

public static java.lang.String recordsToString(org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records)

Represent the records as a comma-delimited String of topic-part@offset.

Parameters:

records - the records.

Returns:

the String.

unwrapIfNeeded

public static java.lang.Exception unwrapIfNeeded(java.lang.Exception exception)

Remove a TimestampedException, if present. Remove a ListenerExecutionFailedException, if present.

Parameters:

exception - the exception.

Returns:

the unwrapped cause or cause of cause.

Since:

2.8.11