Class RetryTemplate

java.lang.Object

org.springframework.core.retry.RetryTemplate

All Implemented Interfaces:

RetryOperations

public class RetryTemplate
extends Object
implements RetryOperations

A basic implementation of RetryOperations that executes and potentially retries a Retryable operation based on a configured RetryPolicy.

By default, a retryable operation will be retried at most 3 times with a fixed backoff of 1 second.

A RetryListener can be registered to react to events published during key retry phases (before a retry attempt, after a retry attempt, etc.).

All retry actions performed by this template are logged at debug level, using "org.springframework.core.retry.RetryTemplate" as the log category.

Since:

7.0

Author:

Mahmoud Ben Hassine, Sam Brannen, Juergen Hoeller

See Also:

• RetryOperations
• RetryPolicy
• BackOff
• RetryListener
• Retryable

Constructor Summary

Constructors

Constructor	Description
RetryTemplate()	Create a new RetryTemplate with maximum 3 retry attempts and a fixed backoff of 1 second.
RetryTemplate(RetryPolicy retryPolicy)	Create a new RetryTemplate with the supplied RetryPolicy.

Method Summary

Modifier and Type	Method	Description
<R extends @Nullable Object> R	execute(Retryable<R> retryable)	Execute the supplied Retryable operation according to the configured RetryPolicy.
RetryListener	getRetryListener()	Return the current RetryListener that is in use with this template.
RetryPolicy	getRetryPolicy()	Return the current RetryPolicy that is in use with this template.
void	setRetryListener(RetryListener retryListener)	Set the RetryListener to use.
void	setRetryPolicy(RetryPolicy retryPolicy)	Set the RetryPolicy to use.

Methods inherited from class Object

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

Constructor Details

RetryTemplate

public RetryTemplate()

Create a new RetryTemplate with maximum 3 retry attempts and a fixed backoff of 1 second.

See Also:

• RetryPolicy.withDefaults()

RetryTemplate

public RetryTemplate(RetryPolicy retryPolicy)

Create a new RetryTemplate with the supplied RetryPolicy.

Parameters:

retryPolicy - the retry policy to use

Method Details

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

Set the RetryPolicy to use.

Defaults to RetryPolicy.withDefaults().

Parameters:

retryPolicy - the retry policy to use

See Also:

• RetryPolicy.withDefaults()
• RetryPolicy.withMaxAttempts(long)
• RetryPolicy.builder()

getRetryPolicy

public RetryPolicy getRetryPolicy()

Return the current RetryPolicy that is in use with this template.

setRetryListener

public void setRetryListener(RetryListener retryListener)

Set the RetryListener to use.

If multiple listeners are needed, use a CompositeRetryListener.

Defaults to a no-op implementation.

Parameters:

retryListener - the retry listener to use

getRetryListener

public RetryListener getRetryListener()

Return the current RetryListener that is in use with this template.

execute

public <R extends @Nullable Object> R execute(Retryable<R> retryable)
                                       throws RetryException

Execute the supplied Retryable operation according to the configured RetryPolicy.

If the Retryable succeeds, its result will be returned. Otherwise, a RetryException will be thrown to the caller. The RetryException will contain the last exception thrown by the Retryable operation as the cause and any exceptions from previous attempts as suppressed exceptions.

Specified by:

execute in interface RetryOperations

Type Parameters:

R - the type of the result

Parameters:

retryable - the Retryable to execute and retry if needed

Returns:

the result of the Retryable, if any

Throws:

RetryException - if the RetryPolicy is exhausted