Class DurationRetryPolicy

  • All Implemented Interfaces:

    public class DurationRetryPolicy
    extends Object
    implements RetryPolicy
    A duration based implementation of RetryPolicy.

    This strategy will signal end of retries when the elapsed time from the first error occurrence surpasses the configurable max duration, 30 seconds by default.

     import ratpack.exec.ExecResult;
     import ratpack.exec.Promise;
     import ratpack.exec.util.retry.DurationRetryPolicy;
     import ratpack.exec.util.retry.RetryPolicy;
     import ratpack.exec.util.retry.FixedDelay;
     import ratpack.test.exec.ExecHarness;
     import ratpack.test.internal.time.FixedWindableClock;
     import java.time.Duration;
     import java.time.Instant;
     import java.time.ZoneOffset;
     import java.util.Arrays;
     import java.util.LinkedList;
     import java.util.List;
     import java.util.concurrent.atomic.AtomicInteger;
     import static org.junit.jupiter.api.Assertions.assertEquals;
     public class Example {
       private static final List<String> LOG = new LinkedList<>();
       public static void main(String... args) throws Exception {
         AtomicInteger source = new AtomicInteger();
         FixedWindableClock clock = new FixedWindableClock(, ZoneOffset.UTC);
         RetryPolicy retryPolicy = DurationRetryPolicy.of(b -> b
         RuntimeException e = new RuntimeException("!");
         Throwable result = ExecHarness.yieldSingle(exec ->
             .mapIf(i -> i == 3, i -> {
               return i;
             .map(i -> { throw new IllegalStateException(); })
             .retry(retryPolicy, (i, t) -> LOG.add("retry attempt: " + i))
         assertEquals("java.lang.IllegalStateException", result.getClass().getCanonicalName());
         assertEquals(Arrays.asList("retry attempt: 1", "retry attempt: 2"), LOG);
    See Also:
    • Constructor Detail

      • DurationRetryPolicy

        public DurationRetryPolicy​(Delay delay,
                                   Duration maxDuration,
                                   Clock clock)
    • Method Detail

      • of

        public static DurationRetryPolicy of​(Action<? super DurationRetryPolicyBuilder> definition)
                                      throws Exception
        Builds a new duration based retry policy from the given definition.
        definition - the duration based retry policy definition
        a duration based retry policy
        Exception - any thrown by building the duration based retry policy
      • isExhausted

        public boolean isExhausted()
        If the caller should stop retrying.
        Specified by:
        isExhausted in interface RetryPolicy
        TRUE if the caller should stop retrying
      • attempts

        public int attempts()
        Attempts performed so far. Starts on 1, i.e. when no retry has been performed yet this returns 1.
        Specified by:
        attempts in interface RetryPolicy
        attempts performed so far.
      • increaseAttempt

        public RetryPolicy increaseAttempt()
        Increase number of attempts.
        Specified by:
        increaseAttempt in interface RetryPolicy
        this policy after updating the internal state around attempts