Class RetryTask<V extends @Nullable Object, E extends Exception>

java.lang.Object

org.springframework.core.retry.support.RetryTask<V,E>

Type Parameters:

V - the returned value type, if any

E - the exception propagated, if any

All Implemented Interfaces:

Callable<V>, TaskCallback<V,E>

public class RetryTask<V extends @Nullable Object, E extends Exception>
extends Object
implements TaskCallback<V,E>

A TaskCallback that executes a given retryable task, re-executing it after failure according to a retry policy. Inherits Callable through TaskCallback.

For regular construction, this is designed to match the SyncTaskExecutor.execute(TaskCallback) signature for propagating specific exception types but is also usable with the Callback-based methods on AsyncTaskExecutor.

Alternatively, this class can also be used to wrap a given Callable or Runnable into corresponding retrying variants: see the common static wrap methods. This is particularly useful for existing Callable and Runnable classes, as well as for scheduling methods which typically accept a Runnable in their signature.

Since:

7.0.4

Author:

Juergen Hoeller

See Also:

• RetryTemplate
• SyncTaskExecutor.execute(TaskCallback)
• AsyncTaskExecutor.submit(Callable)
• AsyncTaskExecutor.submitCompletable(Callable)

Constructor Summary

Constructors

Constructor	Description
RetryTask(TaskCallback<V,E> task)	Create a new RetryTask for the given retryable task.
RetryTask(TaskCallback<V,E> task, RetryOperations retryTemplate)	Create a new RetryTask for the given retryable task.
RetryTask(TaskCallback<V,E> task, RetryPolicy retryPolicy)	Create a new RetryTask for the given retryable task.

Method Summary

Modifier and Type	Method	Description
V	call()
String	getName()	Return the name of the retryable task: by default, the class name of the target task.
String	toString()
static Runnable	wrap(Runnable task)	Wrap the given target Runnable into a retrying Runnable.
static Runnable	wrap(Runnable task, RetryOperations retryTemplate)	Wrap the given target Runnable into a retrying Runnable.
static Runnable	wrap(Runnable task, RetryPolicy retryPolicy)	Wrap the given target Runnable into a retrying Runnable.
static <V> Callable<V>	wrap(Callable<V> task)	Wrap the given target Callable into a retrying Callable.
static <V> Callable<V>	wrap(Callable<V> task, RetryOperations retryTemplate)	Wrap the given target Callable into a retrying Callable.
static <V> Callable<V>	wrap(Callable<V> task, RetryPolicy retryPolicy)	Wrap the given target Callable into a retrying Callable.

Methods inherited from class Object

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

Constructor Details

RetryTask

public RetryTask(TaskCallback<V,E> task)

Create a new RetryTask for the given retryable task.

Parameters:

task - a task that allows for re-execution after failure

See Also:

• RetryPolicy.withDefaults()
• RetryTask(TaskCallback, RetryPolicy)
• RetryTask(TaskCallback, RetryOperations)

RetryTask

public RetryTask(TaskCallback<V,E> task,
 RetryPolicy retryPolicy)

Create a new RetryTask for the given retryable task.

Parameters:

task - a task that allows for re-execution after failure

retryPolicy - the retry policy to apply

See Also:

• RetryTask(TaskCallback, RetryOperations)

RetryTask

public RetryTask(TaskCallback<V,E> task,
 RetryOperations retryTemplate)

Create a new RetryTask for the given retryable task.

Parameters:

task - a task that allows for re-execution after failure

retryTemplate - the retry delegate to use (typically a RetryTemplate but declaring the RetryOperations interface for flexibility)

Method Details

call

public V call()
       throws E

Specified by:

call in interface Callable<V extends @Nullable Object>

Specified by:

call in interface TaskCallback<V extends @Nullable Object, E extends Exception>

Throws:

E

getName

public String getName()

Return the name of the retryable task: by default, the class name of the target task.

See Also:

• Retryable.getName()

toString

public String toString()

Overrides:

toString in class Object

wrap

public static <V> Callable<V> wrap(Callable<V> task)

Wrap the given target Callable into a retrying Callable.

Parameters:

task - a task that allows for re-execution after failure

See Also:

• RetryPolicy.withDefaults()
• wrap(Callable, RetryPolicy)
• wrap(Callable, RetryOperations)

wrap

public static <V> Callable<V> wrap(Callable<V> task,
 RetryPolicy retryPolicy)

Wrap the given target Callable into a retrying Callable.

Parameters:

task - a task that allows for re-execution after failure

retryPolicy - the retry policy to apply

See Also:

• wrap(Callable, RetryOperations)

wrap

public static <V> Callable<V> wrap(Callable<V> task,
 RetryOperations retryTemplate)

Wrap the given target Callable into a retrying Callable.

Parameters:

task - a task that allows for re-execution after failure

retryTemplate - the retry delegate to use (typically a RetryTemplate but declaring the RetryOperations interface for flexibility)

wrap

public static Runnable wrap(Runnable task)

Wrap the given target Runnable into a retrying Runnable.

Parameters:

task - a task that allows for re-execution after failure

See Also:

• RetryPolicy.withDefaults()
• wrap(Runnable, RetryPolicy)
• wrap(Runnable, RetryOperations)

wrap

public static Runnable wrap(Runnable task,
 RetryPolicy retryPolicy)

Wrap the given target Runnable into a retrying Runnable.

Parameters:

task - a task that allows for re-execution after failure

retryPolicy - the retry policy to apply

See Also:

• wrap(Runnable, RetryOperations)

wrap

public static Runnable wrap(Runnable task,
 RetryOperations retryTemplate)

Wrap the given target Runnable into a retrying Runnable.

Parameters:

task - a task that allows for re-execution after failure

retryTemplate - the retry delegate to use (typically a RetryTemplate but declaring the RetryOperations interface for flexibility)