Deprecated API

Contents

• Interfaces
• Classes
• Fields
• Methods
• Constructors
• Enum Constants

Interfaces

Interface	Description
org.springframework.kafka.config.StreamsBuilderFactoryBeanCustomizer	in favor of StreamsBuilderFactoryBeanConfigurer due to a name clash with a similar class in Spring Boot.
org.springframework.kafka.core.KafkaFailureCallback	as of 2.9.1, in favor of CompletableFuture.whenComplete(BiConsumer)
org.springframework.kafka.core.KafkaSendCallback	as of 2.9.1, in favor of CompletableFuture.whenComplete(BiConsumer)

Classes

Class	Description
org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.listener.LoggingErrorHandler	- use the CommonLoggingErrorHandler instead.
org.springframework.kafka.listener.SeekToCurrentBatchErrorHandler	with no replacement - use DefaultErrorHandler with an infinite BackOff.
org.springframework.kafka.transaction.ChainedKafkaTransactionManager	Refer to the ChainedTransactionManager javadocs.

Fields

Field	Description
org.springframework.kafka.support.KafkaHeaders.MESSAGE_KEY	in favor of KafkaHeaders.KEY.
org.springframework.kafka.support.KafkaHeaders.PARTITION_ID	in favor of KafkaHeaders.PARTITION.
org.springframework.kafka.support.KafkaHeaders.RECEIVED_MESSAGE_KEY	in favor of KafkaHeaders.RECEIVED_KEY.
org.springframework.kafka.support.KafkaHeaders.RECEIVED_PARTITION_ID	in favor of KafkaHeaders.RECEIVED_PARTITION.
org.springframework.kafka.support.serializer.ErrorHandlingDeserializer.KEY_DESERIALIZER_EXCEPTION_HEADER	in favor of SerializationUtils.KEY_DESERIALIZER_EXCEPTION_HEADER.
org.springframework.kafka.support.serializer.ErrorHandlingDeserializer.KEY_DESERIALIZER_EXCEPTION_HEADER_PREFIX	in favor of SerializationUtils.DESERIALIZER_EXCEPTION_HEADER_PREFIX.
org.springframework.kafka.support.serializer.ErrorHandlingDeserializer.VALUE_DESERIALIZER_EXCEPTION_HEADER	in favor of SerializationUtils.VALUE_DESERIALIZER_EXCEPTION_HEADER.

Methods

Method	Description
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory.setBatchErrorHandler(BatchErrorHandler)	in favor of AbstractKafkaListenerContainerFactory.setCommonErrorHandler(CommonErrorHandler)
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory.setErrorHandler(ErrorHandler)	in favor of AbstractKafkaListenerContainerFactory.setCommonErrorHandler(CommonErrorHandler)
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory.setMessageConverter(MessageConverter)	since 2.9.6 in favor of AbstractKafkaListenerContainerFactory.setBatchMessageConverter(BatchMessageConverter) and AbstractKafkaListenerContainerFactory.setRecordMessageConverter(RecordMessageConverter).
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory.setRecoveryCallback(RecoveryCallback<? extends Object>)	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory.setRetryTemplate(RetryTemplate)	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerContainerFactory.setStatefulRetry(boolean)	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerEndpoint.getRecoveryCallback()	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerEndpoint.getRetryTemplate()
org.springframework.kafka.config.AbstractKafkaListenerEndpoint.isStatefulRetry()	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerEndpoint.setRecoveryCallback(RecoveryCallback<? extends Object>)	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerEndpoint.setRetryTemplate(RetryTemplate)	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.AbstractKafkaListenerEndpoint.setStatefulRetry(boolean)	since 2.8 - use a suitably configured error handler instead.
org.springframework.kafka.config.StreamsBuilderFactoryBean.setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)	in favor of StreamsBuilderFactoryBean.setStreamsUncaughtExceptionHandler(StreamsUncaughtExceptionHandler).
org.springframework.kafka.core.KafkaOperations.send(String, V)	see KafkaOperations.usingCompletableFuture()
org.springframework.kafka.core.KafkaOperations.sendDefault(V)	see KafkaOperations.usingCompletableFuture()
org.springframework.kafka.core.KafkaOperations.sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata>)	in the 3.0.0 KafkaProducer.
org.springframework.kafka.core.KafkaTemplate.sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata>)
org.springframework.kafka.core.reactive.ReactiveKafkaProducerTemplate.flush()	- flush does not make sense in the context of a reactive flow since, the send completion signal is a send result, which implies that a flush is redundant. If you use this method with reactor-kafka 1.3 or later, it must be scheduled to avoid a deadlock; see https://issues.apache.org/jira/browse/KAFKA-10790 (since 2.7).
org.springframework.kafka.core.RoutingKafkaTemplate.sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata>, String)
org.springframework.kafka.listener.AbstractMessageListenerContainer.getGenericErrorHandler()	in favor of AbstractMessageListenerContainer.getCommonErrorHandler()
org.springframework.kafka.listener.AbstractMessageListenerContainer.setBatchErrorHandler(BatchErrorHandler)	in favor of AbstractMessageListenerContainer.setCommonErrorHandler(CommonErrorHandler)
org.springframework.kafka.listener.AbstractMessageListenerContainer.setErrorHandler(ErrorHandler)	in favor of AbstractMessageListenerContainer.setCommonErrorHandler(CommonErrorHandler)
org.springframework.kafka.listener.AbstractMessageListenerContainer.setGenericErrorHandler(GenericErrorHandler<?>)	in favor of AbstractMessageListenerContainer.setCommonErrorHandler(CommonErrorHandler)
org.springframework.kafka.listener.CommonContainerStoppingErrorHandler.remainingRecords()
org.springframework.kafka.listener.CommonErrorHandler.handleRecord(Exception, ConsumerRecord<?, ?>, Consumer<?, ?>, MessageListenerContainer)	in favor of CommonErrorHandler.handleOne(Exception, ConsumerRecord, Consumer, MessageListenerContainer).
org.springframework.kafka.listener.CommonErrorHandler.onPartitionsAssigned(Consumer<?, ?>, Collection<TopicPartition>)	in favor of CommonErrorHandler.onPartitionsAssigned(Consumer, Collection, Runnable).
org.springframework.kafka.listener.CommonErrorHandler.remainingRecords()	in favor of CommonErrorHandler.seeksAfterHandling().
org.springframework.kafka.listener.ConsumerProperties.getAuthorizationExceptionRetryInterval()	in favor of ConsumerProperties.getAuthExceptionRetryInterval().
org.springframework.kafka.listener.ConsumerProperties.isOnlyLogRecordMetadata()
org.springframework.kafka.listener.ConsumerProperties.setAuthorizationExceptionRetryInterval(Duration)	in favor of ConsumerProperties.setAuthExceptionRetryInterval(Duration).
org.springframework.kafka.listener.ConsumerProperties.setOnlyLogRecordMetadata(boolean)	in favor of KafkaUtils.setConsumerRecordFormatter(java.util.function.Function).
org.springframework.kafka.listener.ContainerProperties.EOSMode.getMode()	aliases will be removed in 3.0
org.springframework.kafka.listener.ContainerProperties.getConsumerStartTimout()
org.springframework.kafka.listener.ContainerProperties.getConsumerTaskExecutor()	in favor of ContainerProperties.getListenerTaskExecutor().
org.springframework.kafka.listener.ContainerProperties.setConsumerStartTimout(Duration)
org.springframework.kafka.listener.ContainerProperties.setConsumerTaskExecutor(AsyncListenableTaskExecutor)	in favor of ContainerProperties.setListenerTaskExecutor(AsyncTaskExecutor).
org.springframework.kafka.listener.DeadLetterPublishingRecoverer.setReplaceOriginalHeaders(boolean)	in favor of DeadLetterPublishingRecoverer.setAppendOriginalHeaders(boolean).
org.springframework.kafka.listener.DefaultErrorHandler.remainingRecords()
org.springframework.kafka.listener.ErrorHandlingUtils.retryBatch(Exception, ConsumerRecords<?, ?>, Consumer<?, ?>, MessageListenerContainer, Runnable, BackOff, CommonErrorHandler, BiConsumer<ConsumerRecords<?, ?>, Exception>, LogAccessor, KafkaException.Level)	in favor of ErrorHandlingUtils.retryBatch(Exception, ConsumerRecords, Consumer, MessageListenerContainer, Runnable, BackOff, CommonErrorHandler, BiConsumer, LogAccessor, org.springframework.kafka.KafkaException.Level, List, BinaryExceptionClassifier).
org.springframework.kafka.listener.ExceptionClassifier.removeNotRetryableException(Class<? extends Exception>)	in favor of ExceptionClassifier.removeClassification(Class)
org.springframework.kafka.listener.FailedRecordProcessor.getRecoveryStrategy(List<ConsumerRecord<?, ?>>, Exception)	- no longer used.
org.springframework.kafka.listener.ListenerUtils.byteArrayToDeserializationException(LogAccessor, byte[])	in favor of SerializationUtils.getExceptionFromHeader(ConsumerRecord, String, LogAccessor) or SerializationUtils.byteArrayToDeserializationException(LogAccessor, org.apache.kafka.common.header.Header).
org.springframework.kafka.listener.ListenerUtils.getExceptionFromHeader(ConsumerRecord<?, ?>, String, LogAccessor)	in favor of SerializationUtils.getExceptionFromHeader(ConsumerRecord, String, LogAccessor).
org.springframework.kafka.listener.ListenerUtils.recordToString(ConsumerRecord<?, ?>)	in favor of KafkaUtils.format(ConsumerRecord).
org.springframework.kafka.listener.ListenerUtils.setLogOnlyMetadata(boolean)	in favor of KafkaUtils.format(ConsumerRecord).
org.springframework.kafka.listener.ListenerUtils.unrecoverableBackOff(BackOff, ThreadLocal<BackOffExecution>, ThreadLocal<Long>)	since 2.7 in favor of ListenerUtils.unrecoverableBackOff(BackOff, ThreadLocal, ThreadLocal, MessageListenerContainer).
org.springframework.kafka.listener.RecordInterceptor.intercept(ConsumerRecord<K, V>)	in favor of RecordInterceptor.intercept(ConsumerRecord, Consumer) which will become the required method in a future release.
org.springframework.kafka.retrytopic.RetryTopicConfigurationBuilder.dltHandlerMethod(Class<?>, String)	in favor of RetryTopicConfigurationBuilder.dltHandlerMethod(String, String).
org.springframework.kafka.support.Acknowledgment.nack(long)	in favor of Acknowledgment.nack(Duration)
org.springframework.kafka.support.JacksonUtils.enhancedObjectMapper(ClassLoader)	since 2.7.5 in favor of JacksonUtils.enhancedObjectMapper()
org.springframework.kafka.support.KafkaUtils.format(ConsumerRecord<?, ?>, boolean)	in favor of KafkaUtils.format(ConsumerRecord).
org.springframework.kafka.test.utils.KafkaTestUtils.getOneRecord(String, String, String, int, boolean, boolean, long)	in favor of getOneRecord(String, String, String, int, boolean, boolean, Duration)
org.springframework.kafka.test.utils.KafkaTestUtils.getRecords(Consumer<K, V>, long)	in favor of getRecords(Consumer, Duration)
org.springframework.kafka.test.utils.KafkaTestUtils.getSingleRecord(Consumer<K, V>, String, long)	in favor of getSingleRecord(Consumer, String, Duration)

Constructors

Constructor	Description
org.springframework.kafka.listener.adapter.DelegatingInvocableHandler(List<InvocableHandlerMethod>, Object, BeanExpressionResolver, BeanExpressionContext)	in favor of DelegatingInvocableHandler(List, InvocableHandlerMethod, Object, BeanExpressionResolver, BeanExpressionContext, BeanFactory, Validator)
org.springframework.kafka.listener.TimestampedException(Exception, Clock)
org.springframework.kafka.retrytopic.DefaultDestinationTopicResolver(Clock, ApplicationContext)
org.springframework.kafka.retrytopic.RetryTopicConfigurer(DestinationTopicProcessor, ListenerContainerFactoryResolver, ListenerContainerFactoryConfigurer, BeanFactory)
org.springframework.kafka.support.micrometer.MicrometerHolder(ApplicationContext, String, String, String, Map<String, String>)	in favor of MicrometerHolder(ApplicationContext, String, String, String, Function).

Enum Constants

Enum Constant	Description
org.springframework.kafka.listener.ContainerProperties.EOSMode.ALPHA	in favor of ContainerProperties.EOSMode.V1.
org.springframework.kafka.listener.ContainerProperties.EOSMode.BETA	in favor of ContainerProperties.EOSMode.V2.
org.springframework.kafka.listener.ContainerProperties.EOSMode.V1	3.0 and later will require 2.5+ brokers