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	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	onRetrySuccess(RetryPolicy retryPolicy, Retryable<?> retryable, @Nullable Object result)	Called after the first successful retry attempt.

Method Details

beforeRetry

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

Called before every retry attempt.

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

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.getCause()
• Throwable.getSuppressed()
• 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 an InterruptedException as the cause and any exceptions from previous invocations of the Retryable operation as suppressed exceptions

See Also:

• RetryException.getCause()
• Throwable.getSuppressed()
• RetryException.getRetryCount()