Package fish.payara.microprofile.faulttolerance.policy

Class RetryPolicy

java.lang.Object

fish.payara.microprofile.faulttolerance.policy.Policy

fish.payara.microprofile.faulttolerance.policy.RetryPolicy

All Implemented Interfaces:

Serializable

public final class RetryPolicy
extends Policy

The resolved "cached" information of a Retry annotation an a specific method.

Author:

Jan Bernitt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Class<? extends Throwable>[]	abortOn
long	delay
ChronoUnit	delayUnit
ChronoUnit	durationUnit
long	jitter
ChronoUnit	jitterDelayUnit
long	maxDuration
int	maxRetries
Class<? extends Throwable>[]	retryOn

Constructor Summary

Constructors

Constructor	Description
RetryPolicy(Method annotatedMethod, int maxRetries, long delay, ChronoUnit delayUnit, long maxDuration, ChronoUnit durationUnit, long jitter, ChronoUnit jitterDelayUnit, Class<? extends Throwable>[] retryOn, Class<? extends Throwable>[] abortOn)

Method Summary

Modifier and Type	Method	Description
static RetryPolicy	create(jakarta.interceptor.InvocationContext context, FaultToleranceConfig config)
boolean	isDelayed()
boolean	isMaxDurationSet()
boolean	isMaxRetriesSet()
boolean	isNone()
long	jitteredDelay()
boolean	retryOn(Throwable ex)	Should a retry occur then the given Throwable is thrown? Relevant section from Retry javadocs: When a method returns and the retry policy is present, the following rules are applied: If the method returns normally (doesn't throw), the result is simply returned.
Long	timeoutTimeNow()
int	totalAttempts()

Methods inherited from class fish.payara.microprofile.faulttolerance.policy.Policy

checkAtLeast, checkAtLeast, checkAtLeast, checkAtMost, checkReturnsSameAs, checkReturnsSameAs, describe, isCaught

Methods inherited from class java.lang.Object

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

Field Detail

maxRetries

public final int maxRetries

delay

public final long delay

delayUnit

public final ChronoUnit delayUnit

maxDuration

public final long maxDuration

durationUnit

public final ChronoUnit durationUnit

jitter

public final long jitter

jitterDelayUnit

public final ChronoUnit jitterDelayUnit

retryOn

public final Class<? extends Throwable>[] retryOn

abortOn

public final Class<? extends Throwable>[] abortOn

Constructor Detail

RetryPolicy

public RetryPolicy(Method annotatedMethod,
                   int maxRetries,
                   long delay,
                   ChronoUnit delayUnit,
                   long maxDuration,
                   ChronoUnit durationUnit,
                   long jitter,
                   ChronoUnit jitterDelayUnit,
                   Class<? extends Throwable>[] retryOn,
                   Class<? extends Throwable>[] abortOn)

Method Detail

create

public static RetryPolicy create(jakarta.interceptor.InvocationContext context,
                                 FaultToleranceConfig config)

isNone

public boolean isNone()

retryOn

public boolean retryOn(Throwable ex)

Should a retry occur then the given Throwable is thrown? Relevant section from Retry javadocs:

When a method returns and the retry policy is present, the following rules are applied:

1. If the method returns normally (doesn't throw), the result is simply returned.
2. Otherwise, if the thrown object is assignable to any value in the #abortOn() parameter, the thrown object is rethrown.
3. Otherwise, if the thrown object is assignable to any value in the #retryOn() parameter, the method call is retried.
4. Otherwise the thrown object is rethrown.

Parameters:

ex - an Error or an Exception

Returns:

true, if a retry should occur, else false.

timeoutTimeNow

public Long timeoutTimeNow()

isDelayed

public boolean isDelayed()

jitteredDelay

public long jitteredDelay()

totalAttempts

public int totalAttempts()

isMaxRetriesSet

public boolean isMaxRetriesSet()

isMaxDurationSet

public boolean isMaxDurationSet()