Add Properties to Deprecation Annotations

garyrussell · artembilan · commit 9066598098df · 2022-09-21T17:14:53.000-04:00
Indicate since and removal.

Also

- remove deprecations from 2.8 (except those related to error handlers)
- remove `RetryingMessageListenerAdapter` which was temporarily reinstated for SIK
- remove `TransactionSupport` - no longer used anywhere
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/config/AbstractKafkaListenerContainerFactory.java b/spring-kafka/src/main/java/org/springframework/kafka/config/AbstractKafkaListenerContainerFactory.java
@@ -213,7 +213,7 @@ public void setReplyTemplate(KafkaTemplate<?, ?> replyTemplate) {
 	 * @deprecated in favor of {@link #setCommonErrorHandler(CommonErrorHandler)}
 	 * @see #setCommonErrorHandler(CommonErrorHandler)
 	 */
-	@Deprecated
+	@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 	public void setErrorHandler(org.springframework.kafka.listener.ErrorHandler errorHandler) {
 		this.errorHandler = errorHandler;
 	}
@@ -225,7 +225,7 @@ public void setErrorHandler(org.springframework.kafka.listener.ErrorHandler erro
 	 * @deprecated in favor of {@link #setCommonErrorHandler(CommonErrorHandler)}
 	 * @see #setCommonErrorHandler(CommonErrorHandler)
 	 */
-	@Deprecated
+	@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 	public void setBatchErrorHandler(org.springframework.kafka.listener.BatchErrorHandler errorHandler) {
 		this.errorHandler = errorHandler;
 	}
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/core/DefaultKafkaProducerFactory.java b/spring-kafka/src/main/java/org/springframework/kafka/core/DefaultKafkaProducerFactory.java
@@ -440,7 +440,7 @@ public boolean isProducerPerThread() {
 	 * {@code org.springframework.kafka.listener.ContainerProperties.EOSMode#V1} is no
 	 * longer supported.
 	 */
-	@Deprecated
+	@Deprecated(since = "3.0", forRemoval = true) // in 3.1
 	public void setProducerPerConsumerPartition(boolean producerPerConsumerPartition) {
 	}
 
@@ -452,7 +452,7 @@ public void setProducerPerConsumerPartition(boolean producerPerConsumerPartition
 	 * {@code org.springframework.kafka.listener.ContainerProperties.EOSMode#V1} is no
 	 * longer supported.
 	 */
-	@Deprecated
+	@Deprecated(since = "3.0", forRemoval = true) // in 3.1
 	@Override
 	public boolean isProducerPerConsumerPartition() {
 		return false;
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/core/KafkaOperations2.java b/spring-kafka/src/main/java/org/springframework/kafka/core/KafkaOperations2.java
@@ -50,7 +50,7 @@
  * @since 2.9
  * @deprecated no longer needed; use {@code KafkaOperations}.
  */
-@Deprecated
+@Deprecated(since = "3.0", forRemoval = true) // in 3.1
 public interface KafkaOperations2<K, V> {
 
 	/**
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/core/ProducerFactory.java b/spring-kafka/src/main/java/org/springframework/kafka/core/ProducerFactory.java
@@ -84,7 +84,7 @@ default boolean transactionCapable() {
 	 * @since 1.3.8
 	 * @deprecated - no longer needed.
 	 */
-	@Deprecated
+	@Deprecated(since = "3.0", forRemoval = true) // in 3.1
 	default void closeProducerFor(String transactionIdSuffix) {
 	}
 
@@ -96,7 +96,7 @@ default void closeProducerFor(String transactionIdSuffix) {
 	 * {@code org.springframework.kafka.listener.ContainerProperties.EOSMode#V1} is no
 	 * longer supported.
 	 */
-	@Deprecated
+	@Deprecated(since = "3.0", forRemoval = true) // in 3.1
 	default boolean isProducerPerConsumerPartition() {
 		return false;
 	}
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/AbstractMessageListenerContainer.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/AbstractMessageListenerContainer.java
@@ -214,7 +214,7 @@ public ApplicationEventPublisher getApplicationEventPublisher() {
 	 * @deprecated in favor of {@link #setCommonErrorHandler(CommonErrorHandler)}
 	 * @see #setCommonErrorHandler(CommonErrorHandler)
 	 */
-	@Deprecated
+	@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 	public void setErrorHandler(ErrorHandler errorHandler) {
 		this.errorHandler = errorHandler;
 	}
@@ -226,7 +226,7 @@ public void setErrorHandler(ErrorHandler errorHandler) {
 	 * @deprecated in favor of {@link #setCommonErrorHandler(CommonErrorHandler)}
 	 * @see #setCommonErrorHandler(CommonErrorHandler)
 	 */
-	@Deprecated
+	@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 	public void setGenericErrorHandler(@Nullable GenericErrorHandler<?> errorHandler) {
 		this.errorHandler = errorHandler;
 	}
@@ -238,7 +238,7 @@ public void setGenericErrorHandler(@Nullable GenericErrorHandler<?> errorHandler
 	 * @deprecated in favor of {@link #setCommonErrorHandler(CommonErrorHandler)}
 	 * @see #setCommonErrorHandler(CommonErrorHandler)
 	 */
-	@Deprecated
+	@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 	public void setBatchErrorHandler(BatchErrorHandler errorHandler) {
 		this.errorHandler = errorHandler;
 	}
@@ -250,7 +250,7 @@ public void setBatchErrorHandler(BatchErrorHandler errorHandler) {
 	 * @deprecated in favor of {@link #getCommonErrorHandler()}
 	 * @see #getCommonErrorHandler()
 	 */
-	@Deprecated
+	@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 	@Nullable
 	public GenericErrorHandler<?> getGenericErrorHandler() {
 		return this.errorHandler;
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/BatchErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/BatchErrorHandler.java
@@ -31,7 +31,7 @@
  * @since 1.1
  * @deprecated in favor of {@link CommonErrorHandler}.
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 public interface BatchErrorHandler extends GenericErrorHandler<ConsumerRecords<?, ?>> {
 
 	/**
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/CommonContainerStoppingErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/CommonContainerStoppingErrorHandler.java
@@ -71,7 +71,7 @@ public void setStopContainerAbnormally(boolean stopContainerAbnormally) {
 	}
 
 	@Override
-	@Deprecated
+	@Deprecated(since = "2.9", forRemoval = true) // in 3.1
 	public boolean remainingRecords() {
 		return true;
 	}
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/CommonErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/CommonErrorHandler.java
@@ -47,7 +47,7 @@ public interface CommonErrorHandler extends DeliveryAttemptAware {
 	 * @see #handleRecord(Exception, ConsumerRecord, Consumer, MessageListenerContainer)
 	 * @see #handleRemaining(Exception, List, Consumer, MessageListenerContainer)
 	 */
-	@Deprecated
+	@Deprecated(since = "2.9", forRemoval = true) // in 3.1
 	default boolean remainingRecords() {
 		return false;
 	}
@@ -97,7 +97,7 @@ default void handleOtherException(Exception thrownException, Consumer<?, ?> cons
 	 * {@link #handleOne(Exception, ConsumerRecord, Consumer, MessageListenerContainer)}.
 	 * @see #remainingRecords()
 	 */
-	@Deprecated
+	@Deprecated(since = "2.9", forRemoval = true) // in 3.1
 	default void handleRecord(Exception thrownException, ConsumerRecord<?, ?> record, Consumer<?, ?> consumer,
 			MessageListenerContainer container) {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/CommonLoggingErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/CommonLoggingErrorHandler.java
@@ -48,7 +48,7 @@ public void setAckAfterHandle(boolean ackAfterHandle) {
 	}
 
 	@Override
-	@Deprecated
+	@Deprecated(since = "2.9", forRemoval = true) // in 3.1
 	public void handleRecord(Exception thrownException, ConsumerRecord<?, ?> record, Consumer<?, ?> consumer,
 			MessageListenerContainer container) {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareBatchErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareBatchErrorHandler.java
@@ -30,7 +30,7 @@
  * @deprecated in favor of {@link CommonErrorHandler}.
  *
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface ConsumerAwareBatchErrorHandler extends BatchErrorHandler {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareErrorHandler.java
@@ -32,7 +32,7 @@
  * @deprecated in favor of {@link CommonErrorHandler}.
  *
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface ConsumerAwareErrorHandler extends ErrorHandler {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareRecordInterceptor.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareRecordInterceptor.java
@@ -29,7 +29,7 @@
  * @deprecated - use {@link RecordInterceptor}.
  *
  */
-@Deprecated
+@Deprecated(since = "3.0", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface ConsumerAwareRecordInterceptor<K, V> extends RecordInterceptor<K, V> {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerAwareBatchErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerAwareBatchErrorHandler.java
@@ -29,7 +29,7 @@
  * @since 2.1
  * @deprecated in favor of {@link CommonErrorHandler}.
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface ContainerAwareBatchErrorHandler extends ConsumerAwareBatchErrorHandler {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerAwareErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerAwareErrorHandler.java
@@ -34,7 +34,7 @@
  * @deprecated in favor of {@link CommonErrorHandler}.
  *
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface ContainerAwareErrorHandler extends RemainingRecordsErrorHandler {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/DefaultErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/DefaultErrorHandler.java
@@ -134,7 +134,7 @@ public void setAckAfterHandle(boolean ackAfterHandle) {
 	}
 
 	@Override
-	@Deprecated
+	@Deprecated(since = "2.9", forRemoval = true) // in 3.1
 	public boolean remainingRecords() {
 		return isSeekAfterError();
 	}
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ErrorHandler.java
@@ -28,7 +28,7 @@
  * @author Gary Russell
  * @deprecated in favor of {@link CommonErrorHandler}.
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 public interface ErrorHandler extends GenericErrorHandler<ConsumerRecord<?, ?>> {
 
 	/**
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ExceptionClassifier.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ExceptionClassifier.java
@@ -159,30 +159,6 @@ private void add(boolean classified, Class<? extends Exception>... exceptionType
 		}
 	}
 
-	/**
-	 * Remove an exception type from the configured list. By default, the following
-	 * exceptions will not be retried:
-	 * <ul>
-	 * <li>{@link DeserializationException}</li>
-	 * <li>{@link MessageConversionException}</li>
-	 * <li>{@link ConversionException}</li>
-	 * <li>{@link MethodArgumentResolutionException}</li>
-	 * <li>{@link NoSuchMethodException}</li>
-	 * <li>{@link ClassCastException}</li>
-	 * </ul>
-	 * All others will be retried, unless {@link #defaultFalse()} has been called.
-	 * @param exceptionType the exception type.
-	 * @return true if the removal was successful.
-	 * @deprecated in favor of {@link #removeClassification(Class)}
-	 * @see #addNotRetryableExceptions(Class...)
-	 * @see #setClassifications(Map, boolean)
-	 * @see #defaultFalse()
-	 */
-	@Deprecated
-	public boolean removeNotRetryableException(Class<? extends Exception> exceptionType) {
-		return Boolean.TRUE.equals(removeClassification(exceptionType)) ? true : false;
-	}
-
 	/**
 	 * Remove an exception type from the configured list. By default, the following
 	 * exceptions will not be retried:
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/FailedRecordProcessor.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/FailedRecordProcessor.java
@@ -23,7 +23,6 @@
 import java.util.function.BiFunction;
 
 import org.apache.commons.logging.LogFactory;
-import org.apache.kafka.clients.consumer.Consumer;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 
 import org.springframework.core.log.LogAccessor;
@@ -172,37 +171,6 @@ public int deliveryAttempt(TopicPartitionOffset topicPartitionOffset) {
 		return this.failureTracker.deliveryAttempt(topicPartitionOffset);
 	}
 
-	/**
-	 * Return a {@link RecoveryStrategy} to call to determine whether the first record in the
-	 * list should be skipped.
-	 * @param records the records.
-	 * @param thrownException the exception.
-	 * @return the {@link RecoveryStrategy}.
-	 * @since 2.7
-	 * @deprecated - no longer used.
-	 */
-	@Deprecated
-	protected RecoveryStrategy getRecoveryStrategy(List<ConsumerRecord<?, ?>> records, Exception thrownException) {
-		return getRecoveryStrategy(records, null, thrownException);
-	}
-
-	/**
-	 * Return a {@link RecoveryStrategy} to call to determine whether the first record in the
-	 * list should be skipped.
-	 * @param records the records.
-	 * @param recoveryConsumer the consumer.
-	 * @param thrownException the exception.
-	 * @return the {@link RecoveryStrategy}.
-	 * @since 2.8.4
-	 * @deprecated - no longer used.
-	 */
-	@Deprecated
-	protected RecoveryStrategy getRecoveryStrategy(List<ConsumerRecord<?, ?>> records,
-												@Nullable Consumer<?, ?> recoveryConsumer, Exception thrownException) {
-
-		return this.failureTracker::recovered;
-	}
-
 	/**
 	 * Return the failed record tracker.
 	 * @return the tracker.
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/GenericErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/GenericErrorHandler.java
@@ -30,7 +30,7 @@
  * @deprecated in favor of {@link CommonErrorHandler}.
  *
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface GenericErrorHandler<T> {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/ListenerInvokingBatchErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/ListenerInvokingBatchErrorHandler.java
@@ -29,7 +29,7 @@
  * @deprecated in favor of {@link CommonErrorHandler}.
  *
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface ListenerInvokingBatchErrorHandler extends ContainerAwareBatchErrorHandler {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/RemainingRecordsErrorHandler.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/RemainingRecordsErrorHandler.java
@@ -34,7 +34,7 @@
  * @deprecated in favor of {@link CommonErrorHandler}.
  *
  */
-@Deprecated
+@Deprecated(since = "2.8", forRemoval = true) // in 3.1
 @FunctionalInterface
 public interface RemainingRecordsErrorHandler extends ConsumerAwareErrorHandler {
 
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/TimestampedException.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/TimestampedException.java
@@ -16,7 +16,6 @@
 
 package org.springframework.kafka.listener;
 
-import java.time.Clock;
 import java.time.Instant;
 
 import org.springframework.kafka.KafkaException;
@@ -34,12 +33,6 @@ public class TimestampedException extends KafkaException {
 
 	private final long timestamp;
 
-	@Deprecated
-	public TimestampedException(Exception ex, Clock clock) {
-		super(ex.getMessage(), ex);
-		this.timestamp = Instant.now(clock).toEpochMilli();
-	}
-
 	/**
 	 * Constructs an instance with the provided cause
 	 * and the current time.
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/listener/adapter/RetryingMessageListenerAdapter.java b/spring-kafka/src/main/java/org/springframework/kafka/listener/adapter/RetryingMessageListenerAdapter.java
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/retrytopic/DefaultDestinationTopicResolver.java b/spring-kafka/src/main/java/org/springframework/kafka/retrytopic/DefaultDestinationTopicResolver.java
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/retrytopic/RetryTopicConfigurer.java b/spring-kafka/src/main/java/org/springframework/kafka/retrytopic/RetryTopicConfigurer.java
diff --git a/spring-kafka/src/main/java/org/springframework/kafka/support/TransactionSupport.java b/spring-kafka/src/main/java/org/springframework/kafka/support/TransactionSupport.java

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public void setStopContainerAbnormally(boolean stopContainerAbnormally) {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`@Override`
`74`		`- @Deprecated`
	`74`	`+ @Deprecated(since = "2.9", forRemoval = true) // in 3.1`
`75`	`75`	`public boolean remainingRecords() {`
`76`	`76`	`return true;`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public void setAckAfterHandle(boolean ackAfterHandle) {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`@Override`
`51`		`- @Deprecated`
	`51`	`+ @Deprecated(since = "2.9", forRemoval = true) // in 3.1`
`52`	`52`	`public void handleRecord(Exception thrownException, ConsumerRecord<?, ?> record, Consumer<?, ?> consumer,`
`53`	`53`	`MessageListenerContainer container) {`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* @deprecated in favor of {@link CommonErrorHandler}.`
`31`	`31`	`*`
`32`	`32`	`*/`
`33`		`-@Deprecated`
	`33`	`+@Deprecated(since = "2.8", forRemoval = true) // in 3.1`
`34`	`34`	`@FunctionalInterface`
`35`	`35`	`public interface ConsumerAwareBatchErrorHandler extends BatchErrorHandler {`
`36`	`36`