org.springframework.amqp.rabbit.config

Class RetryInterceptorBuilder<T extends MethodInterceptor>

java.lang.Object

org.springframework.amqp.rabbit.config.RetryInterceptorBuilder<T>

Type Parameters:

T - The type of MethodInterceptor returned by the builder's build() method.

Direct Known Subclasses:

RetryInterceptorBuilder.StatefulRetryInterceptorBuilder, RetryInterceptorBuilder.StatelessRetryInterceptorBuilder

public abstract class RetryInterceptorBuilder<T extends MethodInterceptor>
extends Object

Simplified facade to make it easier and simpler to build a StatefulRetryOperationsInterceptor or (stateless) RetryOperationsInterceptor by providing a fluent interface to defining the behavior on error.

Typical example:

        StatefulRetryOperationsInterceptor interceptor =
                        RetryInterceptorBuilder.stateful()
                                .maxAttempts(5)
                                .backOffOptions(1, 2, 10) // initialInterval, multiplier, maxInterval
                                .build();
 

When building a stateful interceptor, a message identifier is required. The default behavior determines message identity based on messageId. This isn't a required field and may not be set by the sender. If it is not, you can change the logic to determine message identity using a custom generator:

                StatefulRetryOperationsInterceptor interceptor = RetryInterceptorBuilder.stateful()
                                .messageKeyGenerator(new MyMessageKeyGenerator())
                                .build();
 

Since:

1.3

Author:

James Carr, Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetryInterceptorBuilder.StatefulRetryInterceptorBuilder
static class	RetryInterceptorBuilder.StatelessRetryInterceptorBuilder

Method Summary

Modifier and Type	Method and Description
protected void	applyCommonSettings(AbstractRetryOperationsInterceptorFactoryBean factoryBean)
RetryInterceptorBuilder<T>	backOffOptions(long initialInterval, double multiplier, long maxInterval) Apply the backoff options.
RetryInterceptorBuilder<T>	backOffPolicy(org.springframework.retry.backoff.BackOffPolicy policy) Apply the back off policy.
abstract T	build()
RetryInterceptorBuilder<T>	maxAttempts(int maxAttempts) Apply the max attempts - a SimpleRetryPolicy will be used.
RetryInterceptorBuilder<T>	recoverer(MessageRecoverer recoverer) Apply a Message recoverer - default is to log and discard after retry is exhausted.
RetryInterceptorBuilder<T>	retryOperations(org.springframework.retry.RetryOperations retryOperations) Apply the retry operations - once this is set, other properties can no longer be set; can't be set if other properties have been applied.
RetryInterceptorBuilder<T>	retryPolicy(org.springframework.retry.RetryPolicy policy) Apply the retry policy - cannot be used if a custom retry template has been provided, or the max attempts or back off options or policy have been applied.
static RetryInterceptorBuilder.StatefulRetryInterceptorBuilder	stateful() Create a builder for a stateful retry interceptor.
static RetryInterceptorBuilder.StatelessRetryInterceptorBuilder	stateless() Create a builder for a stateless retry interceptor.

Methods inherited from class java.lang.Object

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

Method Detail

stateful

public static RetryInterceptorBuilder.StatefulRetryInterceptorBuilder stateful()

Create a builder for a stateful retry interceptor.

Returns:

The interceptor builder.

stateless

public static RetryInterceptorBuilder.StatelessRetryInterceptorBuilder stateless()

Create a builder for a stateless retry interceptor.

Returns:

The interceptor builder.

retryOperations

public RetryInterceptorBuilder<T> retryOperations(org.springframework.retry.RetryOperations retryOperations)

Apply the retry operations - once this is set, other properties can no longer be set; can't be set if other properties have been applied.

Parameters:

retryOperations - The retry operations.

Returns:

this.

maxAttempts

public RetryInterceptorBuilder<T> maxAttempts(int maxAttempts)

Apply the max attempts - a SimpleRetryPolicy will be used. Cannot be used if a custom retry operations or retry policy has been set.

Parameters:

maxAttempts - the max attempts.

Returns:

this.

backOffOptions

public RetryInterceptorBuilder<T> backOffOptions(long initialInterval,
                                                 double multiplier,
                                                 long maxInterval)

Apply the backoff options. Cannot be used if a custom retry operations, or back off policy has been set.

Parameters:

initialInterval - The initial interval.

multiplier - The multiplier.

maxInterval - The max interval.

Returns:

this.

retryPolicy

public RetryInterceptorBuilder<T> retryPolicy(org.springframework.retry.RetryPolicy policy)

Apply the retry policy - cannot be used if a custom retry template has been provided, or the max attempts or back off options or policy have been applied.

Parameters:

policy - The policy.

Returns:

this.

backOffPolicy

public RetryInterceptorBuilder<T> backOffPolicy(org.springframework.retry.backoff.BackOffPolicy policy)

Apply the back off policy. Cannot be used if a custom retry operations, or back off policy has been applied.

Parameters:

policy - The policy.

Returns:

this.

recoverer

public RetryInterceptorBuilder<T> recoverer(MessageRecoverer recoverer)

Apply a Message recoverer - default is to log and discard after retry is exhausted.

Parameters:

recoverer - The recoverer.

Returns:

this.

applyCommonSettings

protected void applyCommonSettings(AbstractRetryOperationsInterceptorFactoryBean factoryBean)

build

public abstract T build()