Class CompositeRetryListener

java.lang.Object

org.springframework.core.retry.support.CompositeRetryListener

All Implemented Interfaces:

RetryListener

public class CompositeRetryListener
extends Object
implements RetryListener

A composite implementation of the RetryListener interface, which is used to compose multiple listeners within a RetryTemplate.

Delegate listeners will be called in their registration order.

Since:

7.0

Author:

Mahmoud Ben Hassine, Juergen Hoeller, Sam Brannen

Constructor Summary

Constructors

Constructor	Description
CompositeRetryListener()	Create a new CompositeRetryListener.
CompositeRetryListener(List<RetryListener> listeners)	Create a new CompositeRetryListener with the supplied list of delegates.

Method Summary

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

Methods inherited from class Object

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

Methods inherited from interface RetryListener

beforeRetry

Constructor Details

CompositeRetryListener

public CompositeRetryListener()

Create a new CompositeRetryListener.

See Also:

• addListener(RetryListener)

CompositeRetryListener

public CompositeRetryListener(List<RetryListener> listeners)

Create a new CompositeRetryListener with the supplied list of delegates.

Parameters:

listeners - the list of delegate listeners to register; must not be empty

Method Details

addListener

public void addListener(RetryListener listener)

Add a new listener to the list of delegates.

Parameters:

listener - the listener to add

onRetryableExecution

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

Description copied from interface: RetryListener

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().

Specified by:

onRetryableExecution in interface RetryListener

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)

See Also:

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

beforeRetry

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

Description copied from interface: RetryListener

Called before every retry attempt.

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

Specified by:

beforeRetry in interface RetryListener

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)

See Also:

• RetryListener.onRetryableExecution(RetryPolicy, Retryable, RetryState)

onRetrySuccess

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

Description copied from interface: RetryListener

Called after the first successful retry attempt.

Specified by:

onRetrySuccess in interface RetryListener

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

result - the result of the Retryable operation

onRetryFailure

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

Description copied from interface: RetryListener

Called after every failed retry attempt.

Specified by:

onRetryFailure in interface RetryListener

Parameters:

retryPolicy - the RetryPolicy

retryable - the Retryable operation

throwable - the exception thrown by the Retryable operation

onRetryPolicyExhaustion

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

Description copied from interface: RetryListener

Called if the RetryPolicy is exhausted.

Specified by:

onRetryPolicyExhaustion in interface RetryListener

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

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

Description copied from interface: RetryListener

Called if the RetryPolicy is interrupted between retry attempts.

Specified by:

onRetryPolicyInterruption in interface RetryListener

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

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

Description copied from interface: RetryListener

Called if the configured timeout for a RetryPolicy is exceeded.

Specified by:

onRetryPolicyTimeout in interface RetryListener

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()