net.jodah.lyra.retry

Class RetryPolicy

java.lang.Object

net.jodah.lyra.retry.RetryPolicy

public class RetryPolicy
extends Object

Policy that guides how retries and recovery are performed.

Constructor Summary

Constructors

Constructor and Description
RetryPolicy() Creates a RetryPolicy that always retries by default.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsRetries() Returns whether the policy allows any retries at all based on the configured maxRetries and maxDuration.
Duration	getMaxDuration() Returns the max duration.
int	getMaxRetries() Returns the max retries.
Duration	getMaxRetryInterval() Returns the max retry interval for backoff retries.
Duration	getRetryInterval() Returns the retry interval.
int	getRetryIntervalMultiplier() Returns the retry interval multiplier for backoff retries.
RetryPolicy	withBackoff(Duration retryInterval, Duration maxRetryInterval) Sets the retryInterval to pause for, exponentially backing of to the maxRetryInterval multiplying successive intervals by a factor of 2.
RetryPolicy	withBackoff(Duration retryInterval, Duration maxRetryInterval, int retryIntervalMultiplier) Sets the retryInterval to pause for, exponentially backing of to the maxRetryInterval multiplying successive intervals by the retryIntervalMultiplier.
RetryPolicy	withMaxDuration(Duration maxDuration) Sets the max duration of the RetryPolicy.
RetryPolicy	withMaxRetries(int maxRetries) Sets the max retries to perform.
RetryPolicy	withRetryInterval(Duration retryInterval) Sets the retryInterval to pause for between retries.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryPolicy

public RetryPolicy()

Creates a RetryPolicy that always retries by default.

Method Detail

allowsRetries

public boolean allowsRetries()

Returns whether the policy allows any retries at all based on the configured maxRetries and maxDuration.

getMaxDuration

public Duration getMaxDuration()

Returns the max duration.

See Also:

withMaxDuration(Duration)

getMaxRetries

public int getMaxRetries()

Returns the max retries.

See Also:

withMaxRetries(int)

getMaxRetryInterval

public Duration getMaxRetryInterval()

Returns the max retry interval for backoff retries.

See Also:

withBackoff(Duration, Duration)

getRetryInterval

public Duration getRetryInterval()

Returns the retry interval.

See Also:

withRetryInterval(Duration), withBackoff(Duration, Duration), withBackoff(Duration, Duration, int)

getRetryIntervalMultiplier

public int getRetryIntervalMultiplier()

Returns the retry interval multiplier for backoff retries.

See Also:

withBackoff(Duration, Duration, int)

withBackoff

public RetryPolicy withBackoff(Duration retryInterval,
                      Duration maxRetryInterval)

Sets the retryInterval to pause for, exponentially backing of to the maxRetryInterval multiplying successive intervals by a factor of 2.

Throws:

NullPointerException - if retryInterval or maxRetryInterval are null

IllegalArgumentException - if retryInterval is <= 0, retryInterval is >= maxRetryInterval or the retryIntervalMultiplier is <= 1

withBackoff

public RetryPolicy withBackoff(Duration retryInterval,
                      Duration maxRetryInterval,
                      int retryIntervalMultiplier)

Sets the retryInterval to pause for, exponentially backing of to the maxRetryInterval multiplying successive intervals by the retryIntervalMultiplier.

Throws:

NullPointerException - if retryInterval or maxRetryInterval are null

IllegalArgumentException - if retryInterval is <= 0, retryInterval is >= maxRetryInterval or the retryIntervalMultiplier is <= 1

withMaxDuration

public RetryPolicy withMaxDuration(Duration maxDuration)

Sets the max duration of the RetryPolicy. This is the max amount of time that retries will be performed within, including the max amount of time to wait for resources (connections/channels) to be recovered.

Throws:

NullPointerException - if maxDuration is null

withMaxRetries

public RetryPolicy withMaxRetries(int maxRetries)

Sets the max retries to perform. -1 indicates to always retry.

withRetryInterval

public RetryPolicy withRetryInterval(Duration retryInterval)

Sets the retryInterval to pause for between retries.

Throws:

NullPointerException - if retryInterval is null

IllegalStateException - if backoff intervals have already been set via withBackoff(Duration, Duration) or withBackoff(Duration, Duration, int)