Package org.springframework.kafka.retrytopic

Class RetryTopicComponentFactory

java.lang.Object

org.springframework.kafka.retrytopic.RetryTopicComponentFactory

public class RetryTopicComponentFactory
extends Object

Provide the component instances that will be used with RetryTopicConfigurationSupport. Override any of the methods to provide a different implementation or subclass, then override the RetryTopicConfigurationSupport.createComponentFactory() method to return this factory's subclass.

Since:

2.9

Author:

Tomaz Fernandes

Constructor Summary

Constructors

Constructor	Description
RetryTopicComponentFactory()

Method Summary

Modifier and Type	Method	Description
protected Clock	createInternalRetryTopicClock()	Create a Clock instance that will be used for all time-related operations in the retry topic processes.
DeadLetterPublishingRecovererFactory	deadLetterPublishingRecovererFactory(DestinationTopicResolver destinationTopicResolver)	Create the DeadLetterPublishingRecovererFactory that will be used to create the DeadLetterPublishingRecoverer to forward the records to a given DestinationTopic.
DestinationTopicProcessor	destinationTopicProcessor(DestinationTopicResolver destinationTopicResolver)	Create the DestinationTopicProcessor that will be used to process the DestinationTopic instances and store them in the provided DestinationTopicResolver.
DestinationTopicResolver	destinationTopicResolver()	Create the instance of DestinationTopicResolver that will be used to store the DestinationTopic instance and resolve which a given record should be forwarded to.
Clock	internalRetryTopicClock()	Return the Clock instance that will be used for all time-related operations in the retry topic processes.
KafkaBackOffManagerFactory	kafkaBackOffManagerFactory(ListenerContainerRegistry registry, ApplicationContext applicationContext)	Create the KafkaBackOffManagerFactory that will be used to create the KafkaConsumerBackoffManager instance used to back off the partitions.
ListenerContainerFactoryConfigurer	listenerContainerFactoryConfigurer(KafkaConsumerBackoffManager kafkaConsumerBackoffManager, DeadLetterPublishingRecovererFactory deadLetterPublishingRecovererFactory, Clock clock)	Create a ListenerContainerFactoryConfigurer that will be used to configure the KafkaListenerContainerFactory resolved by the ListenerContainerFactoryResolver.
ListenerContainerFactoryResolver	listenerContainerFactoryResolver(BeanFactory beanFactory)	Create the ListenerContainerFactoryResolver that will be used to resolve the appropriate KafkaListenerContainerFactory for a given topic.
RetryTopicConfigurer	retryTopicConfigurer(DestinationTopicProcessor destinationTopicProcessor, ListenerContainerFactoryConfigurer listenerContainerFactoryConfigurer, ListenerContainerFactoryResolver factoryResolver, RetryTopicNamesProviderFactory retryTopicNamesProviderFactory)	Create the RetryTopicConfigurer that will serve as an entry point for configuring non-blocking topic-based delayed retries for a given KafkaListenerEndpoint, by processing the appropriate RetryTopicConfiguration.
RetryTopicNamesProviderFactory	retryTopicNamesProviderFactory()	Create the RetryTopicNamesProviderFactory instance that will be used to provide the property names for the retry topics' KafkaListenerEndpoint.

Methods inherited from class java.lang.Object

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

Constructor Details

RetryTopicComponentFactory

public RetryTopicComponentFactory()

Method Details

retryTopicConfigurer

public RetryTopicConfigurer retryTopicConfigurer(DestinationTopicProcessor destinationTopicProcessor,
 ListenerContainerFactoryConfigurer listenerContainerFactoryConfigurer,
 ListenerContainerFactoryResolver factoryResolver,
 RetryTopicNamesProviderFactory retryTopicNamesProviderFactory)

Create the RetryTopicConfigurer that will serve as an entry point for configuring non-blocking topic-based delayed retries for a given KafkaListenerEndpoint, by processing the appropriate RetryTopicConfiguration.

Parameters:

destinationTopicProcessor - the DestinationTopicProcessor that will be used to process the DestinationTopic instances and register them in a DestinationTopicContainer.

listenerContainerFactoryConfigurer - the ListenerContainerFactoryConfigurer that will be used to configure the KafkaListenerContainerFactory instances for the non-blocking delayed retries feature.

factoryResolver - the ListenerContainerFactoryResolver that will be used to resolve the proper KafkaListenerContainerFactory for a given endpoint or its retry topics.

retryTopicNamesProviderFactory - the RetryTopicNamesProviderFactory that will be used to provide the property names for the retry topics' endpoints.

Returns:

the instance.

destinationTopicProcessor

public DestinationTopicProcessor destinationTopicProcessor(DestinationTopicResolver destinationTopicResolver)

Create the DestinationTopicProcessor that will be used to process the DestinationTopic instances and store them in the provided DestinationTopicResolver.

Parameters:

destinationTopicResolver - the DestinationTopicResolver instance to be used to store the DestinationTopic instances.

Returns:

the instance.

destinationTopicResolver

public DestinationTopicResolver destinationTopicResolver()

Create the instance of DestinationTopicResolver that will be used to store the DestinationTopic instance and resolve which a given record should be forwarded to.

Returns:

the instance.

deadLetterPublishingRecovererFactory

public DeadLetterPublishingRecovererFactory deadLetterPublishingRecovererFactory(DestinationTopicResolver destinationTopicResolver)

Create the DeadLetterPublishingRecovererFactory that will be used to create the DeadLetterPublishingRecoverer to forward the records to a given DestinationTopic.

Parameters:

destinationTopicResolver - the DestinationTopicResolver instance to resolve the destinations.

Returns:

the instance.

listenerContainerFactoryResolver

public ListenerContainerFactoryResolver listenerContainerFactoryResolver(BeanFactory beanFactory)

Create the ListenerContainerFactoryResolver that will be used to resolve the appropriate KafkaListenerContainerFactory for a given topic.

Parameters:

beanFactory - the BeanFactory that will be used to retrieve the KafkaListenerContainerFactory instance if necessary.

Returns:

the instance.

listenerContainerFactoryConfigurer

public ListenerContainerFactoryConfigurer listenerContainerFactoryConfigurer(KafkaConsumerBackoffManager kafkaConsumerBackoffManager,
 DeadLetterPublishingRecovererFactory deadLetterPublishingRecovererFactory,
 Clock clock)

Create a ListenerContainerFactoryConfigurer that will be used to configure the KafkaListenerContainerFactory resolved by the ListenerContainerFactoryResolver.

Parameters:

kafkaConsumerBackoffManager - the KafkaConsumerBackoffManager used with the KafkaBackoffAwareMessageListenerAdapter.

deadLetterPublishingRecovererFactory - the factory that will provide the DeadLetterPublishingRecoverer instance to be used.

clock - the Clock instance to be used with the listener adapter.

Returns:

the instance.

retryTopicNamesProviderFactory

public RetryTopicNamesProviderFactory retryTopicNamesProviderFactory()

Create the RetryTopicNamesProviderFactory instance that will be used to provide the property names for the retry topics' KafkaListenerEndpoint.

Returns:

the instance.

kafkaBackOffManagerFactory

public KafkaBackOffManagerFactory kafkaBackOffManagerFactory(@Nullable
 ListenerContainerRegistry registry,
 ApplicationContext applicationContext)

Create the KafkaBackOffManagerFactory that will be used to create the KafkaConsumerBackoffManager instance used to back off the partitions.

Parameters:

registry - the ListenerContainerRegistry used to fetch the MessageListenerContainer.

applicationContext - the application context.

Returns:

the instance.

internalRetryTopicClock

public Clock internalRetryTopicClock()

Return the Clock instance that will be used for all time-related operations in the retry topic processes.

Returns:

the instance.

createInternalRetryTopicClock

protected Clock createInternalRetryTopicClock()

Create a Clock instance that will be used for all time-related operations in the retry topic processes.

Returns:

the instance.