org.corfudb.util.retry

Interface IRetry<E extends Exception,F extends Exception,G extends Exception,H extends Exception,O,A extends IRetry>

All Known Implementing Classes:

ExponentialBackoffRetry, IntervalRetry

public interface IRetry<E extends Exception,F extends Exception,G extends Exception,H extends Exception,O,A extends IRetry>

The IRetry interface is used to support retry loops by using different strategies for the pause between the retries. It is done by a builder, that needs the correct strategy and the lambda to be executed. The code in the run function is responsible to handle the exceptions and to decide whether a retry is needed or the exception should be thrown outside.

Created by mwei on 9/1/15

Method Summary

Modifier and Type	Method and Description
static <T extends Exception,U extends Exception,V extends Exception,W extends Exception,R,Z extends IRetry> IRetry<T,U,V,W,R,Z>	build(Class<Z> retryType, Class<? extends T> firstExceptionType, Class<? extends U> secondExceptionType, Class<? extends V> thirdExceptionType, Class<? extends W> fourthExceptionType, IRetryable<T,U,V,W,R> runFunction)
static <T extends Exception,U extends Exception,V extends Exception,R,Z extends IRetry> IRetry<T,U,V,RuntimeException,R,Z>	build(Class<Z> retryType, Class<? extends T> firstExceptionType, Class<? extends U> secondExceptionType, Class<? extends V> thirdExceptionType, IRetryable<T,U,V,RuntimeException,R> runFunction)
static <T extends Exception,U extends Exception,R,Z extends IRetry> IRetry<T,U,RuntimeException,RuntimeException,R,Z>	build(Class<Z> retryType, Class<? extends T> firstExceptionType, Class<? extends U> secondExceptionType, IRetryable<T,U,RuntimeException,RuntimeException,R> runFunction)
static <T extends Exception,R,Z extends IRetry> IRetry<T,RuntimeException,RuntimeException,RuntimeException,R,Z>	build(Class<Z> retryType, Class<? extends T> firstExceptionType, IRetryable<T,RuntimeException,RuntimeException,RuntimeException,R> runFunction)
static <R,Z extends IRetry> IRetry<RuntimeException,RuntimeException,RuntimeException,RuntimeException,R,Z>	build(Class<Z> retryType, IRetryable<RuntimeException,RuntimeException,RuntimeException,RuntimeException,R> runFunction)
IRetryable<E,F,G,H,O>	getRunFunction() Get the function that needs to be retried.
void	nextWait() Apply the retry logic.
default O	run() Run the retry.
default IRetry<E,F,G,H,O,A>	setOptions(Consumer<A> settingsFunction) Configure settings for the underlying class.

Method Detail

build

static <R,Z extends IRetry> IRetry<RuntimeException,RuntimeException,RuntimeException,RuntimeException,R,Z> build(Class<Z> retryType,
                                                                                                                  IRetryable<RuntimeException,RuntimeException,RuntimeException,RuntimeException,R> runFunction)

build

static <T extends Exception,R,Z extends IRetry> IRetry<T,RuntimeException,RuntimeException,RuntimeException,R,Z> build(Class<Z> retryType,
                                                                                                                       Class<? extends T> firstExceptionType,
                                                                                                                       IRetryable<T,RuntimeException,RuntimeException,RuntimeException,R> runFunction)

build

static <T extends Exception,U extends Exception,R,Z extends IRetry> IRetry<T,U,RuntimeException,RuntimeException,R,Z> build(Class<Z> retryType,
                                                                                                                            Class<? extends T> firstExceptionType,
                                                                                                                            Class<? extends U> secondExceptionType,
                                                                                                                            IRetryable<T,U,RuntimeException,RuntimeException,R> runFunction)

build

static <T extends Exception,U extends Exception,V extends Exception,R,Z extends IRetry> IRetry<T,U,V,RuntimeException,R,Z> build(Class<Z> retryType,
                                                                                                                                 Class<? extends T> firstExceptionType,
                                                                                                                                 Class<? extends U> secondExceptionType,
                                                                                                                                 Class<? extends V> thirdExceptionType,
                                                                                                                                 IRetryable<T,U,V,RuntimeException,R> runFunction)

build

static <T extends Exception,U extends Exception,V extends Exception,W extends Exception,R,Z extends IRetry> IRetry<T,U,V,W,R,Z> build(Class<Z> retryType,
                                                                                                                                      Class<? extends T> firstExceptionType,
                                                                                                                                      Class<? extends U> secondExceptionType,
                                                                                                                                      Class<? extends V> thirdExceptionType,
                                                                                                                                      Class<? extends W> fourthExceptionType,
                                                                                                                                      IRetryable<T,U,V,W,R> runFunction)

run

default O run()
       throws E extends Exception,
              F extends Exception,
              G extends Exception,
              H extends Exception,
              InterruptedException

Run the retry. This function may never return.

Throws:

E extends Exception

InterruptedException

getRunFunction

IRetryable<E,F,G,H,O> getRunFunction()

Get the function that needs to be retried.

setOptions

default IRetry<E,F,G,H,O,A> setOptions(Consumer<A> settingsFunction)

Configure settings for the underlying class. The consumer will be given access to the underlying retry type to configure type-specific options.

Parameters:

settingsFunction - A consumer with access to the underlying retry type.

Returns:

An IRetry, to support a fluent API interface.

nextWait

void nextWait()
       throws InterruptedException

Apply the retry logic.

Throws:

InterruptedException