Interface RetryListener

All Known Implementing Classes:

CompositeRetryListener

public interface RetryListener

RetryListener defines a listener API for reacting to events published during the execution of a Retryable operation.

Typically registered in a RetryTemplate, and can be composed using a CompositeRetryListener.

Since:

7.0

Author:

Mahmoud Ben Hassine, Sam Brannen, Juergen Hoeller

See Also:

• CompositeRetryListener

Method Summary

Modifier and Type	Method	Description
default void	beforeRetry(RetryPolicy retryPolicy, Retryable<?> retryable)	Called before every retry attempt.
default void	beforeRetry(RetryPolicy retryPolicy, Retryable<?> retryable, RetryState retryState)	Called before every retry attempt.
default void	onRetryableExecution(RetryPolicy retryPolicy, Retryable<?> retryable, RetryState retryState)	Called after every attempt, including the initial invocation.
default void	onRetryFailure(RetryPolicy retryPolicy, Retryable<?> retryable, Throwable throwable)	Called after every failed retry attempt.
default void	onRetryPolicyExhaustion(RetryPolicy retryPolicy, Retryable<?> retryable, RetryException exception)	Called if the RetryPolicy is exhausted.
default void	onRetryPolicyInterruption(RetryPolicy retryPolicy, Retryable<?> retryable, RetryException exception)	Called if the RetryPolicy is interrupted between retry attempts.
default void	onRetryPolicyTimeout(RetryPolicy retryPolicy, Retryable<?> retryable, RetryException exception)	Called if the configured timeout for a RetryPolicy is exceeded.
default void	onRetrySuccess(RetryPolicy retryPolicy, Retryable<?> retryable, @Nullable Object result)	Called after the first successful retry attempt.

Method Details

onRetryableExecution

default void onRetryableExecution(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 RetryState retryState)

Called after every attempt, including the initial invocation.

The success of the attempt can be checked via RetryState.isSuccessful(); if not successful, the current exception can be introspected via RetryState.getLastException().

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

retryState - the current state of retry processing (this is a live instance reflecting the current state; not intended to be stored)

Since:

7.0.2

See Also:

• RetryTemplate.execute(Retryable)
• RetryState.isSuccessful()
• RetryState.getLastException()
• RetryState.getRetryCount()

beforeRetry

default void beforeRetry(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 RetryState retryState)

Called before every retry attempt.

For a corresponding callback after every retry attempt, consider onRetryableExecution(RetryPolicy, Retryable, RetryState), ignoring the initial attempt through a corresponding RetryState.getRetryCount() check.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

retryState - the current state of retry processing (this is a live instance reflecting the current state; not intended to be stored)

Since:

7.0.4

See Also:

• onRetryableExecution(RetryPolicy, Retryable, RetryState)

beforeRetry

default void beforeRetry(RetryPolicy retryPolicy,
 Retryable<?> retryable)

Called before every retry attempt.

Called by beforeRetry(RetryPolicy, Retryable, RetryState). Implement either this reduced method or that full-argument method, not both.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

See Also:

• beforeRetry(RetryPolicy, Retryable, RetryState)

onRetrySuccess

default void onRetrySuccess(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 @Nullable Object result)

Called after the first successful retry attempt.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

result - the result of the Retryable operation

onRetryFailure

default void onRetryFailure(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 Throwable throwable)

Called after every failed retry attempt.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

throwable - the exception thrown by the Retryable operation

onRetryPolicyExhaustion

default void onRetryPolicyExhaustion(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 RetryException exception)

Called if the RetryPolicy is exhausted.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

exception - the resulting RetryException, with the last exception thrown by the Retryable operation as the cause and any exceptions from previous attempts as suppressed exceptions

See Also:

• RetryException.getExceptions()
• RetryException.getRetryCount()

onRetryPolicyInterruption

default void onRetryPolicyInterruption(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 RetryException exception)

Called if the RetryPolicy is interrupted between retry attempts.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

exception - the resulting RetryException, with the last exception thrown by the Retryable operation as the cause and any exceptions from previous attempts as suppressed exceptions

See Also:

• RetryException.getExceptions()
• RetryException.getRetryCount()

onRetryPolicyTimeout

default void onRetryPolicyTimeout(RetryPolicy retryPolicy,
 Retryable<?> retryable,
 RetryException exception)

Called if the configured timeout for a RetryPolicy is exceeded.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

exception - the resulting RetryException, with the last exception thrown by the Retryable operation as the cause and any exceptions from previous attempts as suppressed exceptions

Since:

7.0.2

See Also:

• RetryException.getExceptions()
• RetryException.getRetryCount()