Package net.jodah.lyra.config

Class RecoveryPolicy

java.lang.Object

net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

net.jodah.lyra.config.RecoveryPolicy

public class RecoveryPolicy
extends net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

Policy that defines how recovery should be performed.

Constructor Summary

Constructors

Constructor	Description
RecoveryPolicy()	Creates a recovery policy that always recovers.

Method Summary

Modifier and Type	Method	Description
boolean	allowsAttempts()	Returns whether the policy allows any attempts based on the configured maxAttempts and maxDuration.
Duration	getInterval()	Returns the interval between attempts.
int	getIntervalMultiplier()	Returns the interval multiplier for backoff attempts.
int	getMaxAttempts()	Returns the max attempts.
Duration	getMaxDuration()	Returns the max duration to perform attempts for.
Duration	getMaxInterval()	Returns the max interval between backoff attempts.
RecoveryPolicy	withBackoff(Duration interval, Duration maxInterval)	Sets the interval to pause for between attempts, exponentially backing of to the maxInterval multiplying successive intervals by a factor of 2.
RecoveryPolicy	withBackoff(Duration interval, Duration maxInterval, int intervalMultiplier)	Sets the interval to pause for between attempts, exponentially backing of to the maxInterval multiplying successive intervals by the intervalMultiplier.
RecoveryPolicy	withInterval(Duration interval)	Sets the interval to pause for between attempts.
RecoveryPolicy	withMaxAttempts(int maxAttempts)	Sets the max number of attempts to perform.
RecoveryPolicy	withMaxDuration(Duration maxDuration)	Sets the max duration to perform attempts for.

Methods inherited from class java.lang.Object

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

Constructor Details

RecoveryPolicy

public RecoveryPolicy()

Creates a recovery policy that always recovers.

Method Details

allowsAttempts

public boolean allowsAttempts()

Returns whether the policy allows any attempts based on the configured maxAttempts and maxDuration.

Overrides:

allowsAttempts in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

getInterval

public Duration getInterval()

Returns the interval between attempts.

Overrides:

getInterval in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

See Also:

withInterval(Duration), withBackoff(Duration, Duration), withBackoff(Duration, Duration, int)

getIntervalMultiplier

public int getIntervalMultiplier()

Returns the interval multiplier for backoff attempts.

Overrides:

getIntervalMultiplier in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

See Also:

withBackoff(Duration, Duration, int)

getMaxAttempts

public int getMaxAttempts()

Returns the max attempts.

Overrides:

getMaxAttempts in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

See Also:

withMaxAttempts(int)

getMaxDuration

public Duration getMaxDuration()

Returns the max duration to perform attempts for.

Overrides:

getMaxDuration in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

See Also:

withMaxDuration(Duration)

getMaxInterval

public Duration getMaxInterval()

Returns the max interval between backoff attempts.

Overrides:

getMaxInterval in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

See Also:

withBackoff(Duration, Duration)

withBackoff

public RecoveryPolicy withBackoff(Duration interval, Duration maxInterval)

Sets the interval to pause for between attempts, exponentially backing of to the maxInterval multiplying successive intervals by a factor of 2.

Overrides:

withBackoff in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

Throws:

java.lang.NullPointerException - if interval or maxInterval are null

java.lang.IllegalArgumentException - if interval is <= 0 or interval is >= maxInterval

withBackoff

public RecoveryPolicy withBackoff(Duration interval, Duration maxInterval, int intervalMultiplier)

Sets the interval to pause for between attempts, exponentially backing of to the maxInterval multiplying successive intervals by the intervalMultiplier.

Overrides:

withBackoff in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

Throws:

java.lang.NullPointerException - if interval or maxInterval are null

java.lang.IllegalArgumentException - if interval is <= 0, interval is >= maxInterval or the intervalMultiplier is <= 1

withInterval

public RecoveryPolicy withInterval(Duration interval)

Sets the interval to pause for between attempts.

Overrides:

withInterval in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

Throws:

java.lang.NullPointerException - if interval is null

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

withMaxAttempts

public RecoveryPolicy withMaxAttempts(int maxAttempts)

Sets the max number of attempts to perform. -1 indicates to always attempt.

Overrides:

withMaxAttempts in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

withMaxDuration

public RecoveryPolicy withMaxDuration(Duration maxDuration)

Sets the max duration to perform attempts for.

Overrides:

withMaxDuration in class net.jodah.lyra.internal.RecurringPolicy<RecoveryPolicy>

Throws:

java.lang.NullPointerException - if maxDuration is null