org.springframework.retry.policy

Class SimpleRetryPolicy

java.lang.Object

org.springframework.retry.policy.SimpleRetryPolicy

All Implemented Interfaces:

Serializable, RetryPolicy

Direct Known Subclasses:

ExpressionRetryPolicy

public class SimpleRetryPolicy
extends Object
implements RetryPolicy

Simple retry policy that retries a fixed number of times for a set of named exceptions (and subclasses). The number of attempts includes the initial try, so e.g.

 retryTemplate = new RetryTemplate(new SimpleRetryPolicy(3));
 retryTemplate.execute(callback);
 

will execute the callback at least once, and as many as 3 times.

Author:

Dave Syer, Rob Harrop, Gary Russell

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_ATTEMPTS The default limit to the number of attempts for a new policy.

Constructor Summary

Constructors

Constructor and Description
SimpleRetryPolicy() Create a SimpleRetryPolicy with the default number of retry attempts, retrying all exceptions.
SimpleRetryPolicy(int maxAttempts) Create a SimpleRetryPolicy with the specified number of retry attempts, retrying all exceptions.
SimpleRetryPolicy(int maxAttempts, Map<Class<? extends Throwable>,Boolean> retryableExceptions) Create a SimpleRetryPolicy with the specified number of retry attempts.
SimpleRetryPolicy(int maxAttempts, Map<Class<? extends Throwable>,Boolean> retryableExceptions, boolean traverseCauses) Create a SimpleRetryPolicy with the specified number of retry attempts.
SimpleRetryPolicy(int maxAttempts, Map<Class<? extends Throwable>,Boolean> retryableExceptions, boolean traverseCauses, boolean defaultValue) Create a SimpleRetryPolicy with the specified number of retry attempts.

Method Summary

Modifier and Type	Method and Description
boolean	canRetry(RetryContext context) Test for retryable operation based on the status.
void	close(RetryContext status)
int	getMaxAttempts() The maximum number of attempts before failure.
RetryContext	open(RetryContext parent) Get a status object that can be used to track the current operation according to this policy.
void	registerThrowable(RetryContext context, Throwable throwable) Update the status with another attempted retry and the latest exception.
void	setMaxAttempts(int maxAttempts) Set the number of attempts before retries are exhausted.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_ATTEMPTS

public static final int DEFAULT_MAX_ATTEMPTS

The default limit to the number of attempts for a new policy.

See Also:

Constant Field Values

Constructor Detail

SimpleRetryPolicy

public SimpleRetryPolicy()

Create a SimpleRetryPolicy with the default number of retry attempts, retrying all exceptions.

SimpleRetryPolicy

public SimpleRetryPolicy(int maxAttempts)

Create a SimpleRetryPolicy with the specified number of retry attempts, retrying all exceptions.

SimpleRetryPolicy

public SimpleRetryPolicy(int maxAttempts,
                         Map<Class<? extends Throwable>,Boolean> retryableExceptions)

Create a SimpleRetryPolicy with the specified number of retry attempts.

Parameters:

maxAttempts - the maximum number of attempts

retryableExceptions - the map of exceptions that are retryable

SimpleRetryPolicy

public SimpleRetryPolicy(int maxAttempts,
                         Map<Class<? extends Throwable>,Boolean> retryableExceptions,
                         boolean traverseCauses)

Create a SimpleRetryPolicy with the specified number of retry attempts. If traverseCauses is true, the exception causes will be traversed until a match is found.

Parameters:

maxAttempts - the maximum number of attempts

retryableExceptions - the map of exceptions that are retryable based on the map value (true/false).

traverseCauses - is this clause traversable

SimpleRetryPolicy

public SimpleRetryPolicy(int maxAttempts,
                         Map<Class<? extends Throwable>,Boolean> retryableExceptions,
                         boolean traverseCauses,
                         boolean defaultValue)

Create a SimpleRetryPolicy with the specified number of retry attempts. If traverseCauses is true, the exception causes will be traversed until a match is found. The default value indicates whether to retry or not for exceptions (or super classes) are not found in the map.

Parameters:

maxAttempts - the maximum number of attempts

retryableExceptions - the map of exceptions that are retryable based on the map value (true/false).

traverseCauses - is this clause traversable

defaultValue - the default action.

Method Detail

setMaxAttempts

public void setMaxAttempts(int maxAttempts)

Set the number of attempts before retries are exhausted. Includes the initial attempt before the retries begin so, generally, will be >= 1. For example setting this property to 3 means 3 attempts total (initial + 2 retries).

Parameters:

maxAttempts - the maximum number of attempts including the initial attempt.

getMaxAttempts

public int getMaxAttempts()

The maximum number of attempts before failure.

Returns:

the maximum number of attempts

canRetry

public boolean canRetry(RetryContext context)

Test for retryable operation based on the status.

Specified by:

canRetry in interface RetryPolicy

Parameters:

context - the current retry status

Returns:

true if the last exception was retryable and the number of attempts so far is less than the limit.

See Also:

RetryPolicy.canRetry(org.springframework.retry.RetryContext)

close

public void close(RetryContext status)

Specified by:

close in interface RetryPolicy

Parameters:

status - a retry status created by the RetryPolicy.open(RetryContext) method of this policy.

See Also:

RetryPolicy.close(RetryContext)

registerThrowable

public void registerThrowable(RetryContext context,
                              Throwable throwable)

Update the status with another attempted retry and the latest exception.

Specified by:

registerThrowable in interface RetryPolicy

Parameters:

context - the current status object.

throwable - the exception to throw

See Also:

RetryPolicy.registerThrowable(RetryContext, Throwable)

open

public RetryContext open(RetryContext parent)

Get a status object that can be used to track the current operation according to this policy. Has to be aware of the latest exception and the number of attempts.

Specified by:

open in interface RetryPolicy

Parameters:

parent - the parent context if we are in a nested retry.

Returns:

a RetryContext object specific to this policy.

See Also:

RetryPolicy.open(RetryContext)

toString

public String toString()

Overrides:

toString in class Object