Package org.springframework.kafka.listener

Class ErrorHandlingUtils

java.lang.Object
org.springframework.kafka.listener.ErrorHandlingUtils
public final class ErrorHandlingUtils extends Object
Utilities for error handling.
Since:
2.8
Author:
Gary Russell, Andrii Pelesh, Antonio Tomac

  • Method Details

    • retryBatch

      public static void retryBatch(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?,?> records, org.apache.kafka.clients.consumer.Consumer<?,?> consumer, MessageListenerContainer container, Runnable invokeListener, BackOff backOff, CommonErrorHandler seeker, BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?,?>,Exception> recoverer, LogAccessor logger, KafkaException.Level logLevel, List<RetryListener> retryListeners, org.springframework.classify.BinaryExceptionClassifier classifier, boolean reClassifyOnExceptionChange)
      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.
      retryListeners - the retry listeners.
      classifier - the exception classifier.
      reClassifyOnExceptionChange - true to reset the state if a different exception is thrown during retry.
      Since:
      2.9.7

    • recordsToString

      public static 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 Exception unwrapIfNeeded(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

    • findRootCause

      public static Exception findRootCause(Exception exception)
      Find the root cause, ignoring any ListenerExecutionFailedException and TimestampedException.
      Parameters:
      exception - the exception to examine.
      Returns:
      the root cause.
      Since:
      3.0.7

    • checkDeserializer

      public static <K, V> boolean checkDeserializer(ConsumerFactory<K,V> consumerFactory, Properties consumerOverrides, boolean isValue, ClassLoader classLoader)
      Determine whether the key or value deserializer is an instance of ErrorHandlingDeserializer.
      Type Parameters:
      K - the key type.
      V - the value type.
      Parameters:
      consumerFactory - the consumer factory.
      consumerOverrides - consumer factory property overrides.
      isValue - true to find the value deserializer.
      classLoader - the class loader to load the deserializer class.
      Returns:
      true if the deserializer is an instance of ErrorHandlingDeserializer.
      Since:
      3.0.10