Package org.apache.camel.util.backoff

Class BackOff

java.lang.Object

org.apache.camel.util.backoff.BackOff

public final class BackOff
extends Object

A back-off policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BackOff.Builder	A builder for BackOff

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_DELAY
static final double	DEFAULT_MULTIPLIER
static final Duration	MAX_DURATION
static final long	NEVER

Constructor Summary

Constructors

Constructor	Description
BackOff()
BackOff(Duration delay, Duration maxDelay, Duration maxElapsedTime, Long maxAttempts, Double multiplier, boolean removeOnComplete)

Method Summary

Modifier and Type	Method	Description
static BackOff.Builder	builder()
static BackOff.Builder	builder(BackOff template)
Duration	getDelay()
Long	getMaxAttempts()
Duration	getMaxDelay()
Duration	getMaxElapsedTime()
Double	getMultiplier()
boolean	isRemoveOnComplete()
void	setDelay(Duration delay)	The delay to wait before retry the operation.
void	setMaxAttempts(Long maxAttempts)	The maximum number of attempts after which the back-off should be considered exhausted and no more attempts should be made.
void	setMaxDelay(Duration maxDelay)	The maximum back-off time after which the delay is not more increased.
void	setMaxElapsedTime(Duration maxElapsedTime)	The maximum elapsed time after which the back-off should be considered exhausted and no more attempts should be made.
void	setMultiplier(Double multiplier)	The value to multiply the current interval by for each retry attempt.
void	setRemoveOnComplete(boolean removeOnComplete)	Should the task be removed from the timer when its complete successfully.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

NEVER

public static final long NEVER

See Also:

• Constant Field Values

MAX_DURATION

public static final Duration MAX_DURATION

DEFAULT_DELAY

public static final Duration DEFAULT_DELAY

DEFAULT_MULTIPLIER

public static final double DEFAULT_MULTIPLIER

See Also:

• Constant Field Values

Constructor Details

BackOff

public BackOff()

BackOff

public BackOff(Duration delay,
 Duration maxDelay,
 Duration maxElapsedTime,
 Long maxAttempts,
 Double multiplier,
 boolean removeOnComplete)

Method Details

getDelay

public Duration getDelay()

setDelay

public void setDelay(Duration delay)

The delay to wait before retry the operation.

getMaxDelay

public Duration getMaxDelay()

setMaxDelay

public void setMaxDelay(Duration maxDelay)

The maximum back-off time after which the delay is not more increased.

getMaxElapsedTime

public Duration getMaxElapsedTime()

setMaxElapsedTime

public void setMaxElapsedTime(Duration maxElapsedTime)

The maximum elapsed time after which the back-off should be considered exhausted and no more attempts should be made.

getMaxAttempts

public Long getMaxAttempts()

setMaxAttempts

public void setMaxAttempts(Long maxAttempts)

The maximum number of attempts after which the back-off should be considered exhausted and no more attempts should be made.

getMultiplier

public Double getMultiplier()

setMultiplier

public void setMultiplier(Double multiplier)

The value to multiply the current interval by for each retry attempt.

isRemoveOnComplete

public boolean isRemoveOnComplete()

setRemoveOnComplete

public void setRemoveOnComplete(boolean removeOnComplete)

Should the task be removed from the timer when its complete successfully.

toString

public String toString()

Overrides:

toString in class Object

builder

public static BackOff.Builder builder()

builder

public static BackOff.Builder builder(BackOff template)