GH-1917 - Make RetryTopic bean names public

Add javadocs

Author: tomazfernandes

spring-kafka/src/main/java/org/springframework/kafka/retrytopic/RetryTopicInternalBeanNames.java

@@ -20,7 +20,7 @@
  *
  * Contains the internal bean names that will be used by the retryable topic configuration.
  *
- * If you provide a bean of your own with the same name that instance will be used instead
+ * If you provide a bean of your own with the same name, your instance will be used instead
  * of the default one.
  *
  * @author Tomaz Fernandes
@@ -29,47 +29,85 @@
  */
 public abstract class RetryTopicInternalBeanNames {
 
-	static final String DESTINATION_TOPIC_PROCESSOR_NAME = "internalDestinationTopicProcessor";
+	/**
+	 * {@link DestinationTopicProcessor} bean name.
+	 */
+	public static final String DESTINATION_TOPIC_PROCESSOR_NAME = "internalDestinationTopicProcessor";
 
-	static final String KAFKA_CONSUMER_BACKOFF_MANAGER = "internalKafkaConsumerBackoffManager";
+	/**
+	 *  {@link org.springframework.kafka.listener.KafkaConsumerBackoffManager} bean name.
+	 */
+	public static final String KAFKA_CONSUMER_BACKOFF_MANAGER = "internalKafkaConsumerBackoffManager";
 
-	static final String LISTENER_CONTAINER_FACTORY_RESOLVER_NAME = "internalListenerContainerFactoryResolver";
+	/**
+	 * {@link ListenerContainerFactoryResolver} bean name.
+	 */
+	public static final String LISTENER_CONTAINER_FACTORY_RESOLVER_NAME = "internalListenerContainerFactoryResolver";
 
-	static final String LISTENER_CONTAINER_FACTORY_CONFIGURER_NAME = "internalListenerContainerFactoryConfigurer";
+	/**
+	 * {@link ListenerContainerFactoryConfigurer} bean name.
+	 */
+	public static final String LISTENER_CONTAINER_FACTORY_CONFIGURER_NAME = "internalListenerContainerFactoryConfigurer";
 
-	static final String DEAD_LETTER_PUBLISHING_RECOVERER_PROVIDER_NAME = "internalDeadLetterPublishingRecovererProvider";
+	/**
+	 * {@link DeadLetterPublishingRecovererFactory} bean name.
+	 */
+	public static final String DEAD_LETTER_PUBLISHING_RECOVERER_PROVIDER_NAME = "internalDeadLetterPublishingRecovererProvider";
 
-	static final String DESTINATION_TOPIC_CONTAINER_NAME = "internalDestinationTopicContainer";
+	/**
+	 * {@link DestinationTopicContainer} bean name.
+	 */
+	public static final String DESTINATION_TOPIC_CONTAINER_NAME = "internalDestinationTopicContainer";
 
-	static final String DEFAULT_LISTENER_FACTORY_BEAN_NAME = "internalRetryTopicListenerContainerFactory";
+	/**
+	 * The default {@link org.springframework.kafka.config.KafkaListenerContainerFactory}
+	 * bean name that will be looked up if no other is provided.
+	 */
+	public static final String DEFAULT_LISTENER_FACTORY_BEAN_NAME = "internalRetryTopicListenerContainerFactory";
 
-	static final String BACKOFF_SLEEPER_BEAN_NAME = "internalBackoffSleeper";
+	/**
+	 * {@link org.springframework.retry.backoff.Sleeper} bean name.
+	 */
+	public static final String BACKOFF_SLEEPER_BEAN_NAME = "internalBackoffSleeper";
 
-	static final String BACKOFF_TASK_EXECUTOR = "internalBackOffTaskExecutor";
+	/**
+	 * {@link org.springframework.core.task.TaskExecutor} bean name to be used.
+	 * in the {@link org.springframework.kafka.listener.WakingKafkaConsumerTimingAdjuster}
+	 */
+	public static final String BACKOFF_TASK_EXECUTOR = "internalBackOffTaskExecutor";
 
-	static final String INTERNAL_BACKOFF_TIMING_ADJUSTMENT_MANAGER = "internalKafkaConsumerTimingAdjustmentManager";
+	/**
+	 * {@link org.springframework.kafka.listener.KafkaConsumerTimingAdjuster} bean name.
+	 */
+	public static final String INTERNAL_BACKOFF_TIMING_ADJUSTMENT_MANAGER = "internalKafkaConsumerTimingAdjustmentManager";
 
-	static final String INTERNAL_KAFKA_CONSUMER_BACKOFF_MANAGER_FACTORY = "internalKafkaConsumerBackOffManagerFactory";
+	/**
+	 * {@link org.springframework.kafka.listener.KafkaBackOffManagerFactory} bean name.
+	 */
+	public static final String INTERNAL_KAFKA_CONSUMER_BACKOFF_MANAGER_FACTORY = "internalKafkaConsumerBackOffManagerFactory";
 
-	static final String RETRY_TOPIC_NAMES_PROVIDER_FACTORY = "internalRetryTopicNamesProviderFactory";
+	/**
+	 * {@link RetryTopicNamesProviderFactory} bean name.
+	 */
+	public static final String RETRY_TOPIC_NAMES_PROVIDER_FACTORY = "internalRetryTopicNamesProviderFactory";
 
 	/**
-	 * Internal Back Off Clock Bean Name.
+	 * The {@link java.time.Clock} bean name that will be used for backing off partitions.
 	 */
 	public static final String INTERNAL_BACKOFF_CLOCK_BEAN_NAME = "internalBackOffClock";
 
 	/**
-	 * Default Kafka template bean name for publishing to retry topics.
+	 * Default {@link org.springframework.kafka.core.KafkaTemplate} bean name for publishing to retry topics.
 	 */
 	public static final String DEFAULT_KAFKA_TEMPLATE_BEAN_NAME = "retryTopicDefaultKafkaTemplate";
 
 	/**
-	 * RetryTopicBootstrapper bean name.
+	 * {@link RetryTopicBootstrapper} bean name.
 	 */
 	public static final String RETRY_TOPIC_BOOTSTRAPPER = "internalRetryTopicBootstrapper";
 
 	/**
-	 * RetryTopicConfigurer bean name.
+	 * {@link RetryTopicConfigurer} bean name.
 	 */
 	public static final String RETRY_TOPIC_CONFIGURER = "internalRetryTopicConfigurer";