Package org.springframework.kafka.listener

Class DeadLetterPublishingRecoverer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.springframework.core.log.LogAccessor logger  

    • Constructor Summary

      Constructors 
      Constructor Description
      DeadLetterPublishingRecoverer​(java.util.Map<java.lang.Class<?>,​KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object>> templates)
      Create an instance with the provided templates and a default destination resolving function that returns a TopicPartition based on the original topic (appended with ".DLT") from the failed record, and the same partition as the failed record.
      DeadLetterPublishingRecoverer​(java.util.Map<java.lang.Class<?>,​KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object>> templates, java.util.function.BiFunction<org.apache.kafka.clients.consumer.ConsumerRecord<?,​?>,​java.lang.Exception,​org.apache.kafka.common.TopicPartition> destinationResolver)
      Create an instance with the provided templates and destination resolving function, that receives the failed consumer record and the exception and returns a TopicPartition.
      DeadLetterPublishingRecoverer​(KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object> template)
      Create an instance with the provided template and a default destination resolving function that returns a TopicPartition based on the original topic (appended with ".DLT") from the failed record, and the same partition as the failed record.
      DeadLetterPublishingRecoverer​(KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object> template, java.util.function.BiFunction<org.apache.kafka.clients.consumer.ConsumerRecord<?,​?>,​java.lang.Exception,​org.apache.kafka.common.TopicPartition> destinationResolver)
      Create an instance with the provided template and destination resolving function, that receives the failed consumer record and the exception and returns a TopicPartition.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(org.apache.kafka.clients.consumer.ConsumerRecord<?,​?> record, org.apache.kafka.clients.consumer.Consumer<?,​?> consumer, java.lang.Exception exception)
      Recover the record.
      protected org.apache.kafka.clients.producer.ProducerRecord<java.lang.Object,​java.lang.Object> createProducerRecord​(org.apache.kafka.clients.consumer.ConsumerRecord<?,​?> record, org.apache.kafka.common.TopicPartition topicPartition, org.apache.kafka.common.header.Headers headers, byte[] key, byte[] value)
      Subclasses can override this method to customize the producer record to send to the DLQ.
      protected void publish​(org.apache.kafka.clients.producer.ProducerRecord<java.lang.Object,​java.lang.Object> outRecord, KafkaOperations<java.lang.Object,​java.lang.Object> kafkaTemplate)
      Override this if you want more than just logging of the send result.
      protected void send​(org.apache.kafka.clients.producer.ProducerRecord<java.lang.Object,​java.lang.Object> outRecord, KafkaOperations<java.lang.Object,​java.lang.Object> kafkaTemplate)
      Send the record.
      void setHeadersFunction​(java.util.function.BiFunction<org.apache.kafka.clients.consumer.ConsumerRecord<?,​?>,​java.lang.Exception,​org.apache.kafka.common.header.Headers> headersFunction)
      Set a function which will be called to obtain additional headers to add to the published record.
      void setPartitionInfoTimeout​(java.time.Duration partitionInfoTimeout)
      Time to wait for partition information when verifying.
      void setRetainExceptionHeader​(boolean retainExceptionHeader)
      Set to true to retain a Java serialized DeserializationException header.
      void setVerifyPartition​(boolean verifyPartition)
      Set to false to disable partition verification.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.function.BiConsumer

        andThen

    • Field Detail

      • logger

        protected final org.springframework.core.log.LogAccessor logger

    • Constructor Detail

      • DeadLetterPublishingRecoverer

        public DeadLetterPublishingRecoverer​(KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object> template)
        Create an instance with the provided template and a default destination resolving function that returns a TopicPartition based on the original topic (appended with ".DLT") from the failed record, and the same partition as the failed record. Therefore the dead-letter topic must have at least as many partitions as the original topic.
        Parameters:
        template - the KafkaOperations to use for publishing.

      • DeadLetterPublishingRecoverer

        public DeadLetterPublishingRecoverer​(KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object> template,
                                     java.util.function.BiFunction<org.apache.kafka.clients.consumer.ConsumerRecord<?,​?>,​java.lang.Exception,​org.apache.kafka.common.TopicPartition> destinationResolver)
        Create an instance with the provided template and destination resolving function, that receives the failed consumer record and the exception and returns a TopicPartition. If the partition in the TopicPartition is less than 0, no partition is set when publishing to the topic.
        Parameters:
        template - the KafkaOperations to use for publishing.
        destinationResolver - the resolving function.

      • DeadLetterPublishingRecoverer

        public DeadLetterPublishingRecoverer​(java.util.Map<java.lang.Class<?>,​KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object>> templates)
        Create an instance with the provided templates and a default destination resolving function that returns a TopicPartition based on the original topic (appended with ".DLT") from the failed record, and the same partition as the failed record. Therefore the dead-letter topic must have at least as many partitions as the original topic. The templates map keys are classes and the value the corresponding template to use for objects (producer record values) of that type. A LinkedHashMap is recommended when there is more than one template, to ensure the map is traversed in order. To send records with a null value, add a template with the Void class as a key; otherwise the first template from the map values iterator will be used.
        Parameters:
        templates - the KafkaOperationss to use for publishing.

      • DeadLetterPublishingRecoverer

        public DeadLetterPublishingRecoverer​(java.util.Map<java.lang.Class<?>,​KafkaOperations<? extends java.lang.Object,​? extends java.lang.Object>> templates,
                                     java.util.function.BiFunction<org.apache.kafka.clients.consumer.ConsumerRecord<?,​?>,​java.lang.Exception,​org.apache.kafka.common.TopicPartition> destinationResolver)
        Create an instance with the provided templates and destination resolving function, that receives the failed consumer record and the exception and returns a TopicPartition. If the partition in the TopicPartition is less than 0, no partition is set when publishing to the topic. The templates map keys are classes and the value the corresponding template to use for objects (producer record values) of that type. A LinkedHashMap is recommended when there is more than one template, to ensure the map is traversed in order. To send records with a null value, add a template with the Void class as a key; otherwise the first template from the map values iterator will be used.
        Parameters:
        templates - the KafkaOperationss to use for publishing.
        destinationResolver - the resolving function.

    • Method Detail

      • setRetainExceptionHeader

        public void setRetainExceptionHeader​(boolean retainExceptionHeader)
        Set to true to retain a Java serialized DeserializationException header. By default, such headers are removed from the published record, unless both key and value deserialization exceptions occur, in which case, the DLT_* headers are created from the value exception and the key exception header is retained.
        Parameters:
        retainExceptionHeader - true to retain the
        Since:
        2.5

      • setHeadersFunction

        public void setHeadersFunction​(java.util.function.BiFunction<org.apache.kafka.clients.consumer.ConsumerRecord<?,​?>,​java.lang.Exception,​org.apache.kafka.common.header.Headers> headersFunction)
        Set a function which will be called to obtain additional headers to add to the published record.
        Parameters:
        headersFunction - the headers function.
        Since:
        2.5.4

      • setVerifyPartition

        public void setVerifyPartition​(boolean verifyPartition)
        Set to false to disable partition verification. When true, verify that the partition returned by the resolver actually exists. If not, set the ProducerRecord.partition() to null, allowing the producer to determine the destination partition.
        Parameters:
        verifyPartition - false to disable.
        Since:
        2.7
        See Also:
        setPartitionInfoTimeout(Duration)

      • setPartitionInfoTimeout

        public void setPartitionInfoTimeout​(java.time.Duration partitionInfoTimeout)
        Time to wait for partition information when verifying. Default is 5 seconds.
        Parameters:
        partitionInfoTimeout - the timeout.
        Since:
        2.7
        See Also:
        setVerifyPartition(boolean)

      • accept

        public void accept​(org.apache.kafka.clients.consumer.ConsumerRecord<?,​?> record,
                   @Nullable
                   org.apache.kafka.clients.consumer.Consumer<?,​?> consumer,
                   java.lang.Exception exception)
        Description copied from interface: ConsumerAwareRecordRecoverer
        Recover the record.
        Specified by:
        accept in interface ConsumerAwareRecordRecoverer
        Parameters:
        record - the record.
        consumer - the consumer.
        exception - the exception.

      • send

        protected void send​(org.apache.kafka.clients.producer.ProducerRecord<java.lang.Object,​java.lang.Object> outRecord,
                    KafkaOperations<java.lang.Object,​java.lang.Object> kafkaTemplate)
        Send the record.
        Parameters:
        outRecord - the record.
        kafkaTemplate - the template.
        Since:
        2.7

      • createProducerRecord

        protected org.apache.kafka.clients.producer.ProducerRecord<java.lang.Object,​java.lang.Object> createProducerRecord​(org.apache.kafka.clients.consumer.ConsumerRecord<?,​?> record,
                                                                                                                         org.apache.kafka.common.TopicPartition topicPartition,
                                                                                                                         org.apache.kafka.common.header.Headers headers,
                                                                                                                         @Nullable
                                                                                                                         byte[] key,
                                                                                                                         @Nullable
                                                                                                                         byte[] value)
        Subclasses can override this method to customize the producer record to send to the DLQ. The default implementation simply copies the key and value from the consumer record and adds the headers. The timestamp is not set (the original timestamp is in one of the headers). IMPORTANT: if the partition in the TopicPartition is less than 0, it must be set to null in the ProducerRecord.
        Parameters:
        record - the failed record
        topicPartition - the TopicPartition returned by the destination resolver.
        headers - the headers - original record headers plus DLT headers.
        key - the key to use instead of the consumer record key.
        value - the value to use instead of the consumer record value.
        Returns:
        the producer record to send.
        See Also:
        KafkaHeaders

      • publish

        protected void publish​(org.apache.kafka.clients.producer.ProducerRecord<java.lang.Object,​java.lang.Object> outRecord,
                       KafkaOperations<java.lang.Object,​java.lang.Object> kafkaTemplate)
        Override this if you want more than just logging of the send result.
        Parameters:
        outRecord - the record to send.
        kafkaTemplate - the template.
        Since:
        2.2.5