org.springframework.retry

Interface RetryOperations

All Known Implementing Classes:

RetryTemplate

public interface RetryOperations

Defines the basic set of operations implemented by RetryOperations to execute operations with configurable retry behaviour.

Author:

Rob Harrop, Dave Syer

Method Summary

Modifier and Type	Method and Description
<T,E extends Throwable> T	execute(RetryCallback<T,E> retryCallback) Execute the supplied RetryCallback with the configured retry semantics.
<T,E extends Throwable> T	execute(RetryCallback<T,E> retryCallback, RecoveryCallback<T> recoveryCallback) Execute the supplied RetryCallback with a fallback on exhausted retry to the RecoveryCallback.
<T,E extends Throwable> T	execute(RetryCallback<T,E> retryCallback, RecoveryCallback<T> recoveryCallback, RetryState retryState) A stateful retry with a recovery path.
<T,E extends Throwable> T	execute(RetryCallback<T,E> retryCallback, RetryState retryState) A simple stateful retry.

Method Detail

execute

<T,E extends Throwable> T execute(RetryCallback<T,E> retryCallback)
                           throws E extends Throwable

Execute the supplied RetryCallback with the configured retry semantics. See implementations for configuration details.

Type Parameters:

T - the return value

E - the exception to throw

Parameters:

retryCallback - the RetryCallback

Returns:

the value returned by the RetryCallback upon successful invocation.

Throws:

E - any Exception raised by the RetryCallback upon unsuccessful retry.

E - the exception thrown

E extends Throwable

execute

<T,E extends Throwable> T execute(RetryCallback<T,E> retryCallback,
                                  RecoveryCallback<T> recoveryCallback)
                           throws E extends Throwable

Execute the supplied RetryCallback with a fallback on exhausted retry to the RecoveryCallback. See implementations for configuration details.

Type Parameters:

T - the type to return

E - the type of the exception

Parameters:

recoveryCallback - the RecoveryCallback

retryCallback - the RetryCallback RecoveryCallback upon

Returns:

the value returned by the RetryCallback upon successful invocation, and that returned by the RecoveryCallback otherwise.

Throws:

E - any Exception raised by the unsuccessful retry.

E extends Throwable

execute

<T,E extends Throwable> T execute(RetryCallback<T,E> retryCallback,
                                  RetryState retryState)
                           throws E extends Throwable,
                                  ExhaustedRetryException

A simple stateful retry. Execute the supplied RetryCallback with a target object for the attempt identified by the DefaultRetryState. Exceptions thrown by the callback are always propagated immediately so the state is required to be able to identify the previous attempt, if there is one - hence the state is required. Normal patterns would see this method being used inside a transaction, where the callback might invalidate the transaction if it fails. See implementations for configuration details.

Type Parameters:

T - the type of the return value

E - the type of the exception to return

Parameters:

retryCallback - the RetryCallback

retryState - the RetryState

Returns:

the value returned by the RetryCallback upon successful invocation, and that returned by the RecoveryCallback otherwise.

Throws:

E - any Exception raised by the RecoveryCallback.

ExhaustedRetryException - if the last attempt for this state has already been reached

E extends Throwable

execute

<T,E extends Throwable> T execute(RetryCallback<T,E> retryCallback,
                                  RecoveryCallback<T> recoveryCallback,
                                  RetryState retryState)
                           throws E extends Throwable

A stateful retry with a recovery path. Execute the supplied RetryCallback with a fallback on exhausted retry to the RecoveryCallback and a target object for the retry attempt identified by the DefaultRetryState.

Type Parameters:

T - the return value type

E - the exception type

Parameters:

recoveryCallback - the RecoveryCallback

retryState - the RetryState

retryCallback - the RetryCallback

Returns:

the value returned by the RetryCallback upon successful invocation, and that returned by the RecoveryCallback otherwise.

Throws:

E - any Exception raised by the RecoveryCallback upon unsuccessful retry.

E extends Throwable

See Also:

execute(RetryCallback, RetryState)