Implementation of BackOff that increases the back off period for each retry attempt. When the interval has reached the max interval, it is no longer increased. Stops retrying once the max elapsed time has been reached.

Example: The default interval is 2000 ms; the default multiplier is 1.5; and the default max interval is 30000. For 10 attempts the sequence will be as follows:

request#     back off

 1              2000
 2              3000
 3              4500
 4              6750
 5             10125
 6             15187
 7             22780
 8             30000
 9             30000
10             30000

Note that the default max elapsed time is Long#MAX_VALUE, and the default maximum number of attempts is Integer#MAX_VALUE. Use setMaxElapsedTime to limit the length of time that an instance should accumulate before returning BackOffExecution#STOP. Alternatively, use setMaxAttempts to limit the number of attempts. The execution stops when either of those two limits is reached.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ExponentialBackOff.ExponentialBackOffExecution

Field Summary

Modifier and Type	Field and Description
public static final long	DEFAULT_INITIAL_INTERVAL The default initial interval.
public static final int	DEFAULT_MAX_ATTEMPTS The default maximum attempts.
public static final long	DEFAULT_MAX_ELAPSED_TIME The default maximum elapsed time.
public static final long	DEFAULT_MAX_INTERVAL The default maximum back off time.
public static final double	DEFAULT_MULTIPLIER The default multiplier (increases the interval by 50%).
private long	initialInterval
private int	maxAttempts
private long	maxElapsedTime
private long	maxInterval
private double	multiplier

Constructor Summary

Access	Constructor and Description
public	ExponentialBackOff() Create an instance with the default settings.
public	ExponentialBackOff(long the initial interval in milliseconds initialInterval, double the multiplier (should be greater than or equal to 1) multiplier) Create an instance with the supplied settings.

Method Summary

Modifier and Type	Method and Description
private void	checkMultiplier(double multiplier)
public long	getInitialInterval() Return the initial interval in milliseconds.
public int	Returns: the maximum number of attempts getMaxAttempts() Return the maximum number of attempts after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`.
public long	Returns: the maximum elapsed time getMaxElapsedTime() Return the maximum elapsed time in milliseconds after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`.
public long	getMaxInterval() Return the maximum back off time in milliseconds.
public double	getMultiplier() Return the value to multiply the current interval by for each retry attempt.
public void	setInitialInterval(long initialInterval) Set the initial interval in milliseconds.
public void	setMaxAttempts(int the maximum number of attempts maxAttempts) The maximum number of attempts after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`.
public void	setMaxElapsedTime(long the maximum elapsed time maxElapsedTime) Set the maximum elapsed time in milliseconds after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`.
public void	setMaxInterval(long maxInterval) Set the maximum back off time in milliseconds.
public void	setMultiplier(double multiplier) Set the value to multiply the current interval by for each retry attempt.
public BackOffExecution	start() Implements org.springframework.util.backoff.BackOff.start. Start a new back off execution.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

DEFAULT_INITIAL_INTERVAL	back to summary
public static final long DEFAULT_INITIAL_INTERVAL The default initial interval.

DEFAULT_MAX_ATTEMPTS	back to summary
public static final int DEFAULT_MAX_ATTEMPTS The default maximum attempts. Since 6.1

DEFAULT_MAX_ATTEMPTS

back to summary

public static final int DEFAULT_MAX_ATTEMPTS

The default maximum attempts.

Since: 6.1

DEFAULT_MAX_ELAPSED_TIME	back to summary
public static final long DEFAULT_MAX_ELAPSED_TIME The default maximum elapsed time.

DEFAULT_MAX_INTERVAL	back to summary
public static final long DEFAULT_MAX_INTERVAL The default maximum back off time.

DEFAULT_MULTIPLIER	back to summary
public static final double DEFAULT_MULTIPLIER The default multiplier (increases the interval by 50%).

initialInterval	back to summary
private long initialInterval

maxAttempts	back to summary
private int maxAttempts

maxElapsedTime	back to summary
private long maxElapsedTime

maxInterval	back to summary
private long maxInterval

multiplier	back to summary
private double multiplier

Constructor Detail

ExponentialBackOff back to summary

ExponentialBackOff	back to summary
public ExponentialBackOff() Create an instance with the default settings. See Also `DEFAULT_INITIAL_INTERVAL`, `DEFAULT_MULTIPLIER`, `DEFAULT_MAX_INTERVAL`, `DEFAULT_MAX_ELAPSED_TIME`, `DEFAULT_MAX_ATTEMPTS`

public ExponentialBackOff()

Create an instance with the default settings.

See Also: DEFAULT_INITIAL_INTERVAL, DEFAULT_MULTIPLIER, DEFAULT_MAX_INTERVAL, DEFAULT_MAX_ELAPSED_TIME, DEFAULT_MAX_ATTEMPTS

ExponentialBackOff	back to summary
public ExponentialBackOff(long initialInterval, double multiplier) Create an instance with the supplied settings. Parameters initialInterval:long the initial interval in milliseconds multiplier:double the multiplier (should be greater than or equal to 1)

ExponentialBackOff

back to summary

public ExponentialBackOff(long initialInterval, double multiplier)

Create an instance with the supplied settings.

Parameters

initialInterval:long: the initial interval in milliseconds
multiplier:double: the multiplier (should be greater than or equal to 1)

Method Detail

checkMultiplier	back to summary
private void checkMultiplier(double multiplier)

getInitialInterval	back to summary
public long getInitialInterval() Return the initial interval in milliseconds.

getMaxAttempts back to summary

getMaxAttempts	back to summary
public int getMaxAttempts() Return the maximum number of attempts after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`. Returns:int the maximum number of attempts Since 6.1 See Also `getMaxElapsedTime()`

public int getMaxAttempts()

Return the maximum number of attempts after which a call to BackOffExecution#nextBackOff() returns BackOffExecution#STOP.

Returns:int: the maximum number of attempts
Since: 6.1
See Also: getMaxElapsedTime()

getMaxElapsedTime back to summary

getMaxElapsedTime	back to summary
public long getMaxElapsedTime() Return the maximum elapsed time in milliseconds after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`. Returns:long the maximum elapsed time See Also `getMaxAttempts()`

public long getMaxElapsedTime()

Return the maximum elapsed time in milliseconds after which a call to BackOffExecution#nextBackOff() returns BackOffExecution#STOP.

Returns:long: the maximum elapsed time
See Also: getMaxAttempts()

getMaxInterval	back to summary
public long getMaxInterval() Return the maximum back off time in milliseconds.

getMultiplier	back to summary
public double getMultiplier() Return the value to multiply the current interval by for each retry attempt.

setInitialInterval	back to summary
public void setInitialInterval(long initialInterval) Set the initial interval in milliseconds.

setMaxAttempts back to summary

setMaxAttempts	back to summary
public void setMaxAttempts(int maxAttempts) The maximum number of attempts after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`. Parameters maxAttempts:int the maximum number of attempts Since 6.1 See Also `setMaxElapsedTime`

public void setMaxAttempts(int maxAttempts)

The maximum number of attempts after which a call to BackOffExecution#nextBackOff() returns BackOffExecution#STOP.

Parameters

maxAttempts:int: the maximum number of attempts

Since

6.1

See Also

setMaxElapsedTime

setMaxElapsedTime back to summary

setMaxElapsedTime	back to summary
public void setMaxElapsedTime(long maxElapsedTime) Set the maximum elapsed time in milliseconds after which a call to `BackOffExecution#nextBackOff()` returns `BackOffExecution#STOP`. Parameters maxElapsedTime:long the maximum elapsed time See Also `setMaxAttempts`

public void setMaxElapsedTime(long maxElapsedTime)

Set the maximum elapsed time in milliseconds after which a call to BackOffExecution#nextBackOff() returns BackOffExecution#STOP.

Parameters

maxElapsedTime:long: the maximum elapsed time

See Also

setMaxAttempts

setMaxInterval	back to summary
public void setMaxInterval(long maxInterval) Set the maximum back off time in milliseconds.

setMultiplier	back to summary
public void setMultiplier(double multiplier) Set the value to multiply the current interval by for each retry attempt.

start back to summary

start	back to summary
public BackOffExecution start() Implements org.springframework.util.backoff.BackOff.start. Doc from org.springframework.util.backoff.BackOff.start. Start a new back off execution. Returns:BackOffExecution a fresh `BackOffExecution` ready to be used Annotations @Override

public BackOffExecution start()

Implements org.springframework.util.backoff.BackOff.start.

Doc from org.springframework.util.backoff.BackOff.start.

Start a new back off execution.

Returns:BackOffExecution

a fresh BackOffExecution ready to be used

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.util.backoff back to summary

private Class ExponentialBackOff.ExponentialBackOffExecution

Class Inheritance

extends Object
implements BackOffExecution

java.lang.Object
org.springframework.util.backoff.ExponentialBackOff.ExponentialBackOffExecution

All Implemented Interfaces

org.springframework.util.backoff.BackOffExecution

Field Summary

Modifier and Type	Field and Description
private int	attempts
private long	currentElapsedTime
private long	currentInterval

Constructor Summary

Access	Constructor and Description
private	ExponentialBackOffExecution()

Method Summary

Modifier and Type	Method and Description
private long	computeNextInterval()
private long	multiplyInterval(long maxInterval)
public long	nextBackOff() Implements org.springframework.util.backoff.BackOffExecution.nextBackOff. Return the number of milliseconds to wait before retrying the operation or `STOP` (-1) to indicate that no further attempt should be made for the operation.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

attempts	back to summary
private int attempts

currentElapsedTime	back to summary
private long currentElapsedTime

currentInterval	back to summary
private long currentInterval

Constructor Detail

ExponentialBackOffExecution	back to summary
private ExponentialBackOffExecution()

Method Detail

computeNextInterval	back to summary
private long computeNextInterval()

multiplyInterval	back to summary
private long multiplyInterval(long maxInterval)

nextBackOff back to summary

nextBackOff	back to summary
public long nextBackOff() Implements org.springframework.util.backoff.BackOffExecution.nextBackOff. Doc from org.springframework.util.backoff.BackOffExecution.nextBackOff. Return the number of milliseconds to wait before retrying the operation or `STOP` (-1) to indicate that no further attempt should be made for the operation. Annotations @Override

public long nextBackOff()

Implements org.springframework.util.backoff.BackOffExecution.nextBackOff.

Doc from org.springframework.util.backoff.BackOffExecution.nextBackOff.

Return the number of milliseconds to wait before retrying the operation or STOP (-1) to indicate that no further attempt should be made for the operation.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class ExponentialBackOff

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ExponentialBackOff.ExponentialBackOffExecution

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail