Package org.springframework.kafka.retrytopic

Class RetryTopicConfigurationBuilder

java.lang.Object

org.springframework.kafka.retrytopic.RetryTopicConfigurationBuilder

public class RetryTopicConfigurationBuilder
extends java.lang.Object

Builder class to create RetryTopicConfiguration instances.

Since:

2.7

Author:

Tomaz Fernandes, Gary Russell

Constructor Summary

Constructors

Constructor	Description
RetryTopicConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
RetryTopicConfigurationBuilder	autoCreateTopics(boolean shouldCreate, int numPartitions, short replicationFactor)
RetryTopicConfigurationBuilder	autoCreateTopicsWith(int numPartitions, short replicationFactor)
RetryTopicConfigurationBuilder	autoStartDltHandler(java.lang.Boolean autoStart)	Set to false to not start the DLT handler (configured or default); overrides the container factory's autoStartup property.
RetryTopicConfiguration	create(KafkaOperations<?,?> sendToTopicKafkaTemplate)
RetryTopicConfigurationBuilder	customBackoff(org.springframework.retry.backoff.SleepingBackOffPolicy<?> backOffPolicy)
RetryTopicConfigurationBuilder	dltHandlerMethod(java.lang.Class<?> clazz, java.lang.String methodName)	Deprecated. in favor of dltHandlerMethod(String, String).
RetryTopicConfigurationBuilder	dltHandlerMethod(java.lang.String beanName, java.lang.String methodName)	Configure a DLT handler method.
RetryTopicConfigurationBuilder	dltHandlerMethod(EndpointHandlerMethod endpointHandlerMethod)
RetryTopicConfigurationBuilder	dltProcessingFailureStrategy(DltStrategy dltStrategy)
RetryTopicConfigurationBuilder	dltSuffix(java.lang.String suffix)
RetryTopicConfigurationBuilder	doNotAutoCreateRetryTopics()
RetryTopicConfigurationBuilder	doNotConfigureDlt()
RetryTopicConfigurationBuilder	doNotRetryOnDltFailure()
RetryTopicConfigurationBuilder	excludeTopic(java.lang.String topicName)
RetryTopicConfigurationBuilder	excludeTopics(java.util.List<java.lang.String> topicNames)
RetryTopicConfigurationBuilder	exponentialBackoff(long initialInterval, double multiplier, long maxInterval)
RetryTopicConfigurationBuilder	exponentialBackoff(long initialInterval, double multiplier, long maxInterval, boolean withRandom)
RetryTopicConfigurationBuilder	fixedBackOff(int interval)
RetryTopicConfigurationBuilder	fixedBackOff(long interval)
RetryTopicConfigurationBuilder	includeTopic(java.lang.String topicName)
RetryTopicConfigurationBuilder	includeTopics(java.util.List<java.lang.String> topicNames)
RetryTopicConfigurationBuilder	listenerFactory(java.lang.String factoryBeanName)
RetryTopicConfigurationBuilder	listenerFactory(ConcurrentKafkaListenerContainerFactory<?,?> factory)
RetryTopicConfigurationBuilder	maxAttempts(int maxAttempts)
static RetryTopicConfigurationBuilder	newInstance()	Create a new instance of the builder.
RetryTopicConfigurationBuilder	noBackoff()
RetryTopicConfigurationBuilder	notRetryOn(java.lang.Class<? extends java.lang.Throwable> throwable)
RetryTopicConfigurationBuilder	notRetryOn(java.util.List<java.lang.Class<? extends java.lang.Throwable>> throwables)
RetryTopicConfigurationBuilder	retryOn(java.lang.Class<? extends java.lang.Throwable> throwable)
RetryTopicConfigurationBuilder	retryOn(java.util.List<java.lang.Class<? extends java.lang.Throwable>> throwables)
RetryTopicConfigurationBuilder	retryTopicSuffix(java.lang.String suffix)
RetryTopicConfigurationBuilder	setTopicSuffixingStrategy(TopicSuffixingStrategy topicSuffixingStrategy)
RetryTopicConfigurationBuilder	suffixTopicsWithIndexValues()
RetryTopicConfigurationBuilder	timeoutAfter(long timeout)
RetryTopicConfigurationBuilder	traversingCauses()
RetryTopicConfigurationBuilder	traversingCauses(boolean traversing)
RetryTopicConfigurationBuilder	uniformRandomBackoff(long minInterval, long maxInterval)
RetryTopicConfigurationBuilder	useSingleTopicForFixedDelays()
RetryTopicConfigurationBuilder	useSingleTopicForFixedDelays(FixedDelayStrategy useSameTopicForFixedDelays)

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryTopicConfigurationBuilder

public RetryTopicConfigurationBuilder()

Method Detail

dltHandlerMethod

@Deprecated
public RetryTopicConfigurationBuilder dltHandlerMethod(java.lang.Class<?> clazz,
                                                       java.lang.String methodName)

Deprecated.

in favor of dltHandlerMethod(String, String).

Configure a DLT handler method.

Parameters:

clazz - the class containing the method.

methodName - the method name.

Returns:

the builder.

dltHandlerMethod

public RetryTopicConfigurationBuilder dltHandlerMethod(java.lang.String beanName,
                                                       java.lang.String methodName)

Configure a DLT handler method.

Parameters:

beanName - the bean name.

methodName - the method name.

Returns:

the builder.

Since:

2.8

dltHandlerMethod

public RetryTopicConfigurationBuilder dltHandlerMethod(EndpointHandlerMethod endpointHandlerMethod)

doNotRetryOnDltFailure

public RetryTopicConfigurationBuilder doNotRetryOnDltFailure()

dltProcessingFailureStrategy

public RetryTopicConfigurationBuilder dltProcessingFailureStrategy(DltStrategy dltStrategy)

doNotConfigureDlt

public RetryTopicConfigurationBuilder doNotConfigureDlt()

autoStartDltHandler

public RetryTopicConfigurationBuilder autoStartDltHandler(@Nullable
                                                          java.lang.Boolean autoStart)

Set to false to not start the DLT handler (configured or default); overrides the container factory's autoStartup property.

Parameters:

autoStart - false to not auto start.

Returns:

this builder.

Since:

2.8

includeTopics

public RetryTopicConfigurationBuilder includeTopics(java.util.List<java.lang.String> topicNames)

excludeTopics

public RetryTopicConfigurationBuilder excludeTopics(java.util.List<java.lang.String> topicNames)

includeTopic

public RetryTopicConfigurationBuilder includeTopic(java.lang.String topicName)

excludeTopic

public RetryTopicConfigurationBuilder excludeTopic(java.lang.String topicName)

retryTopicSuffix

public RetryTopicConfigurationBuilder retryTopicSuffix(java.lang.String suffix)

dltSuffix

public RetryTopicConfigurationBuilder dltSuffix(java.lang.String suffix)

suffixTopicsWithIndexValues

public RetryTopicConfigurationBuilder suffixTopicsWithIndexValues()

setTopicSuffixingStrategy

public RetryTopicConfigurationBuilder setTopicSuffixingStrategy(TopicSuffixingStrategy topicSuffixingStrategy)

maxAttempts

public RetryTopicConfigurationBuilder maxAttempts(int maxAttempts)

timeoutAfter

public RetryTopicConfigurationBuilder timeoutAfter(long timeout)

exponentialBackoff

public RetryTopicConfigurationBuilder exponentialBackoff(long initialInterval,
                                                         double multiplier,
                                                         long maxInterval)

exponentialBackoff

public RetryTopicConfigurationBuilder exponentialBackoff(long initialInterval,
                                                         double multiplier,
                                                         long maxInterval,
                                                         boolean withRandom)

fixedBackOff

public RetryTopicConfigurationBuilder fixedBackOff(long interval)

uniformRandomBackoff

public RetryTopicConfigurationBuilder uniformRandomBackoff(long minInterval,
                                                           long maxInterval)

noBackoff

public RetryTopicConfigurationBuilder noBackoff()

customBackoff

public RetryTopicConfigurationBuilder customBackoff(org.springframework.retry.backoff.SleepingBackOffPolicy<?> backOffPolicy)

fixedBackOff

public RetryTopicConfigurationBuilder fixedBackOff(int interval)

useSingleTopicForFixedDelays

public RetryTopicConfigurationBuilder useSingleTopicForFixedDelays()

useSingleTopicForFixedDelays

public RetryTopicConfigurationBuilder useSingleTopicForFixedDelays(FixedDelayStrategy useSameTopicForFixedDelays)

doNotAutoCreateRetryTopics

public RetryTopicConfigurationBuilder doNotAutoCreateRetryTopics()

autoCreateTopicsWith

public RetryTopicConfigurationBuilder autoCreateTopicsWith(int numPartitions,
                                                           short replicationFactor)

autoCreateTopics

public RetryTopicConfigurationBuilder autoCreateTopics(boolean shouldCreate,
                                                       int numPartitions,
                                                       short replicationFactor)

retryOn

public RetryTopicConfigurationBuilder retryOn(java.lang.Class<? extends java.lang.Throwable> throwable)

notRetryOn

public RetryTopicConfigurationBuilder notRetryOn(java.lang.Class<? extends java.lang.Throwable> throwable)

retryOn

public RetryTopicConfigurationBuilder retryOn(java.util.List<java.lang.Class<? extends java.lang.Throwable>> throwables)

notRetryOn

public RetryTopicConfigurationBuilder notRetryOn(java.util.List<java.lang.Class<? extends java.lang.Throwable>> throwables)

traversingCauses

public RetryTopicConfigurationBuilder traversingCauses()

traversingCauses

public RetryTopicConfigurationBuilder traversingCauses(boolean traversing)

listenerFactory

public RetryTopicConfigurationBuilder listenerFactory(ConcurrentKafkaListenerContainerFactory<?,?> factory)

listenerFactory

public RetryTopicConfigurationBuilder listenerFactory(java.lang.String factoryBeanName)

create

public RetryTopicConfiguration create(KafkaOperations<?,?> sendToTopicKafkaTemplate)

newInstance

public static RetryTopicConfigurationBuilder newInstance()

Create a new instance of the builder.

Returns:

the new instance.