Package dev.failsafe

Class RetryPolicyConfig<R>

java.lang.Object

dev.failsafe.PolicyConfig<R>

dev.failsafe.FailurePolicyConfig<R>

dev.failsafe.DelayablePolicyConfig<R>

dev.failsafe.RetryPolicyConfig<R>

Type Parameters:

R - result type

public class RetryPolicyConfig<R>
extends DelayablePolicyConfig<R>

Configuration for a RetryPolicy.

This class is threadsafe.

See Also:

• RetryPolicyBuilder

Field Summary

Fields

Modifier and Type	Field	Description
(package private) List<CheckedBiPredicate<R,Throwable>>	abortConditions
(package private) EventListener<ExecutionCompletedEvent<R>>	abortListener
(package private) double	delayFactor
(package private) Duration	delayMax
(package private) Duration	delayMin
(package private) EventListener<ExecutionAttemptedEvent<R>>	failedAttemptListener
(package private) Duration	jitter
(package private) double	jitterFactor
(package private) Duration	maxDelay
(package private) Duration	maxDuration
(package private) int	maxRetries
(package private) EventListener<ExecutionCompletedEvent<R>>	retriesExceededListener
(package private) EventListener<ExecutionAttemptedEvent<R>>	retryListener
(package private) EventListener<ExecutionScheduledEvent<R>>	retryScheduledListener

Fields inherited from class dev.failsafe.DelayablePolicyConfig

delay, delayException, delayFn, delayResult

Fields inherited from class dev.failsafe.FailurePolicyConfig

exceptionsChecked, failureConditions

Fields inherited from class dev.failsafe.PolicyConfig

failureListener, successListener

Constructor Summary

Constructors

Constructor	Description
RetryPolicyConfig()
RetryPolicyConfig(RetryPolicyConfig<R> config)

Method Summary

Modifier and Type	Method	Description
boolean	allowsRetries()	Returns whether the policy config allows retries according to the configured maxRetries and maxDuration.
List<CheckedBiPredicate<R,Throwable>>	getAbortConditions()	Returns the conditions for which an execution result or exception will cause retries to be aborted.
EventListener<ExecutionCompletedEvent<R>>	getAbortListener()	Returns the abort event listener.
Duration	getDelay()	Returns the delay between retries, else Duration.ZERO if delays have not been configured.
double	getDelayFactor()	Returns the delay factor for backoff retries.
Duration	getDelayMax()	Returns the max random delay between retries, else null if random delays have not been configured.
Duration	getDelayMin()	Returns the min random delay between retries, else null if random delays have not been configured.
EventListener<ExecutionAttemptedEvent<R>>	getFailedAttemptListener()	Returns the failed attempt event listener.
Duration	getJitter()	Returns the jitter, else null if none has been configured.
double	getJitterFactor()	Returns the jitter factor, else 0.0 if none has been configured.
int	getMaxAttempts()	Returns the max number of execution attempts to perform.
Duration	getMaxDelay()	Returns the max delay between backoff retries, else null if backoff delays have not been configured.
Duration	getMaxDuration()	Returns the max duration to perform retries for.
int	getMaxRetries()	Returns the max number of retries to perform when an execution attempt fails.
EventListener<ExecutionCompletedEvent<R>>	getRetriesExceededListener()	Returns the retries exceeded event listener.
EventListener<ExecutionAttemptedEvent<R>>	getRetryListener()	Returns the retry event listener.
EventListener<ExecutionScheduledEvent<R>>	getRetryScheduledListener()	Returns the retry scheduled event listener.

Methods inherited from class dev.failsafe.DelayablePolicyConfig

getDelayException, getDelayFn, getDelayResult

Methods inherited from class dev.failsafe.FailurePolicyConfig

getFailureConditions, isExceptionsChecked

Methods inherited from class dev.failsafe.PolicyConfig

getFailureListener, getSuccessListener

Methods inherited from class java.lang.Object

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

Field Details

delayMin

Duration delayMin

delayMax

Duration delayMax

delayFactor

double delayFactor

maxDelay

Duration maxDelay

jitter

Duration jitter

jitterFactor

double jitterFactor

maxDuration

Duration maxDuration

maxRetries

int maxRetries

abortConditions

List<CheckedBiPredicate<R,Throwable>> abortConditions

abortListener

EventListener<ExecutionCompletedEvent<R>> abortListener

failedAttemptListener

EventListener<ExecutionAttemptedEvent<R>> failedAttemptListener

retriesExceededListener

EventListener<ExecutionCompletedEvent<R>> retriesExceededListener

retryListener

EventListener<ExecutionAttemptedEvent<R>> retryListener

retryScheduledListener

EventListener<ExecutionScheduledEvent<R>> retryScheduledListener

Constructor Details

RetryPolicyConfig

RetryPolicyConfig()

RetryPolicyConfig

RetryPolicyConfig(RetryPolicyConfig<R> config)

Method Details

allowsRetries

public boolean allowsRetries()

Returns whether the policy config allows retries according to the configured maxRetries and maxDuration.

See Also:

• RetryPolicyBuilder.withMaxRetries(int)
• RetryPolicyBuilder.withMaxDuration(Duration)

getAbortConditions

public List<CheckedBiPredicate<R,Throwable>> getAbortConditions()

Returns the conditions for which an execution result or exception will cause retries to be aborted.

See Also:

• RetryPolicyBuilder.abortOn(Class...)
• RetryPolicyBuilder.abortOn(List)
• RetryPolicyBuilder.abortOn(CheckedPredicate)
• RetryPolicyBuilder.abortIf(CheckedBiPredicate)
• RetryPolicyBuilder.abortIf(CheckedPredicate)
• RetryPolicyBuilder.abortWhen(Object)

getDelay

public Duration getDelay()

Returns the delay between retries, else Duration.ZERO if delays have not been configured. If backoff delays are configured, this value will represent the initial delay.

Overrides:

getDelay in class DelayablePolicyConfig<R>

See Also:

• RetryPolicyBuilder.withDelay(Duration)
• RetryPolicyBuilder.withBackoff(Duration, Duration, double)
• RetryPolicyBuilder.withBackoff(Duration, Duration, double)
• RetryPolicyBuilder.withBackoff(long, long, ChronoUnit)
• RetryPolicyBuilder.withBackoff(long, long, ChronoUnit, double)

getDelayMin

public Duration getDelayMin()

Returns the min random delay between retries, else null if random delays have not been configured.

See Also:

• RetryPolicyBuilder.withDelay(Duration, Duration)
• RetryPolicyBuilder.withDelay(long, long, ChronoUnit)

getDelayMax

public Duration getDelayMax()

Returns the max random delay between retries, else null if random delays have not been configured.

See Also:

• RetryPolicyBuilder.withDelay(Duration, Duration)
• RetryPolicyBuilder.withDelay(long, long, ChronoUnit)

getDelayFactor

public double getDelayFactor()

Returns the delay factor for backoff retries.

See Also:

• RetryPolicyBuilder.withBackoff(Duration, Duration, double)
• RetryPolicyBuilder.withBackoff(long, long, ChronoUnit, double)

getJitter

public Duration getJitter()

Returns the jitter, else null if none has been configured.

See Also:

• RetryPolicyBuilder.withJitter(Duration)

getJitterFactor

public double getJitterFactor()

Returns the jitter factor, else 0.0 if none has been configured.

See Also:

• RetryPolicyBuilder.withJitter(double)

getMaxAttempts

public int getMaxAttempts()

Returns the max number of execution attempts to perform. A value of -1 represents no limit. Defaults to 3.

See Also:

• RetryPolicyBuilder.withMaxAttempts(int)
• getMaxRetries()

getMaxDelay

public Duration getMaxDelay()

Returns the max delay between backoff retries, else null if backoff delays have not been configured.

See Also:

• RetryPolicyBuilder.withBackoff(Duration, Duration)
• RetryPolicyBuilder.withBackoff(Duration, Duration, double)
• RetryPolicyBuilder.withBackoff(long, long, ChronoUnit)
• RetryPolicyBuilder.withBackoff(long, long, ChronoUnit, double)

getMaxDuration

public Duration getMaxDuration()

Returns the max duration to perform retries for.

See Also:

• RetryPolicyBuilder.withMaxDuration(Duration)

getMaxRetries

public int getMaxRetries()

Returns the max number of retries to perform when an execution attempt fails. A value of -1 represents no limit. Defaults to 2.

See Also:

• RetryPolicyBuilder.withMaxRetries(int)
• getMaxAttempts()

getAbortListener

public EventListener<ExecutionCompletedEvent<R>> getAbortListener()

Returns the abort event listener.

See Also:

• RetryPolicyBuilder.onAbort(EventListener)

getFailedAttemptListener

public EventListener<ExecutionAttemptedEvent<R>> getFailedAttemptListener()

Returns the failed attempt event listener.

See Also:

• RetryPolicyBuilder.onFailedAttempt(EventListener)

getRetriesExceededListener

public EventListener<ExecutionCompletedEvent<R>> getRetriesExceededListener()

Returns the retries exceeded event listener.

See Also:

• RetryPolicyBuilder.onRetriesExceeded(EventListener)

getRetryListener

public EventListener<ExecutionAttemptedEvent<R>> getRetryListener()

Returns the retry event listener.

See Also:

• RetryPolicyBuilder.onRetry(EventListener)

getRetryScheduledListener

public EventListener<ExecutionScheduledEvent<R>> getRetryScheduledListener()

Returns the retry scheduled event listener.

See Also:

• RetryPolicyBuilder.onRetryScheduled(EventListener)