org.kiwiproject.retry.AttemptTimeLimiters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of retrying-again Show documentation
A Java library to allow for the creation of configurable retrying strategies for an arbitrary function call, such as something that communicates with a remote service with flaky uptime.
There is a newer version: 2.1.3
Show newest version
/*
 * Copyright 2012-2015 Ray Holder
 * Modifications copyright 2017-2018 Robert Huffman
 * Modifications copyright 2020-2021 Kiwi Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.kiwiproject.retry;

import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.SimpleTimeLimiter;
import com.google.common.util.concurrent.TimeLimiter;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

/**
 * Factory class for instances of {@link AttemptTimeLimiter}
 */
@SuppressWarnings("WeakerAccess")
public class AttemptTimeLimiters {

    private AttemptTimeLimiters() {
    }

    /**
     * @return an {@link AttemptTimeLimiter} impl which has no time limit
     */
    public static AttemptTimeLimiter noTimeLimit() {
        return new NoAttemptTimeLimit();
    }

    /**
     * For control over thread management, it is preferable to offer an {@link ExecutorService}
     * through the other factory method, {@link #fixedTimeLimit(long, TimeUnit, ExecutorService)}.
     * All calls to this method use the same cached thread pool created by
     * {@link Executors#newCachedThreadPool()}. It is unbounded, meaning there is no limit to
     * the number of threads it will create. It will reuse idle threads if they are available,
     * and idle threads remain alive for 60 seconds.
     *
     * @param duration that an attempt may persist before being circumvented
     * @param timeUnit of the 'duration' arg
     * @return an {@link AttemptTimeLimiter} with a fixed time limit for each attempt
     */
    public static AttemptTimeLimiter fixedTimeLimit(long duration, @Nonnull TimeUnit timeUnit) {
        Preconditions.checkNotNull(timeUnit);
        return new FixedAttemptTimeLimit(duration, timeUnit);
    }

    /**
     * @param duration        that an attempt may persist before being circumvented
     * @param timeUnit        of the 'duration' arg
     * @param executorService used to enforce time limit
     * @return an {@link AttemptTimeLimiter} with a fixed time limit for each attempt
     */
    public static AttemptTimeLimiter fixedTimeLimit(
            long duration, @Nonnull TimeUnit timeUnit, @Nonnull ExecutorService executorService) {
        Preconditions.checkNotNull(timeUnit);
        return new FixedAttemptTimeLimit(duration, timeUnit, executorService);
    }

    @Immutable
    private static final class NoAttemptTimeLimit implements AttemptTimeLimiter {
        @Override
        public  T call(Callable callable) throws Exception {
            return callable.call();
        }
    }

    // Suppress API warnings about TimeLimiter in Guava which has been there since version 1.0
    @SuppressWarnings("UnstableApiUsage")
    @Immutable
    private static final class FixedAttemptTimeLimit implements AttemptTimeLimiter {

        /**
         * ExecutorService used when no ExecutorService is specified in the constructor
         */
        private static final ExecutorService defaultExecutorService = Executors.newCachedThreadPool();

        private final TimeLimiter timeLimiter;
        private final long duration;
        private final TimeUnit timeUnit;

        FixedAttemptTimeLimit(long duration, @Nonnull TimeUnit timeUnit) {
            this(duration, timeUnit, defaultExecutorService);
        }

        FixedAttemptTimeLimit(long duration, @Nonnull TimeUnit timeUnit, @Nonnull ExecutorService executorService) {
            this(SimpleTimeLimiter.create(executorService), duration, timeUnit);
        }

        private FixedAttemptTimeLimit(@Nonnull TimeLimiter timeLimiter, long duration, @Nonnull TimeUnit timeUnit) {
            Preconditions.checkNotNull(timeLimiter);
            Preconditions.checkNotNull(timeUnit);
            this.timeLimiter = timeLimiter;
            this.duration = duration;
            this.timeUnit = timeUnit;
        }

        @Override
        public  T call(Callable callable) throws Exception {
            return timeLimiter.callWithTimeout(callable, duration, timeUnit);
        }
    }
}