com.intuit.wasabi.authentication.util

Class Retriable<T>

java.lang.Object

com.intuit.wasabi.authentication.util.Retriable<T>

Type Parameters:

T - the return parameter of retriableCall()

public abstract class Retriable<T>
extends Object

A Retriable is used to retry authentication calls which can fail due to network errors or timeouts. A typical way to use it looks like this:

     
     int times = 5;
     int timeout = 200;
     Retriable<T> retriable = new Retriable<T>() {
        {@literal @}Override
         public T retriableCall() throws NoSuchAlgorithmException {
             return getSomeT();
         }
     };
     T retrievedT = retriable.retryCallOnFail(times, timeout);
 
 

This will retry the retriable up to five times, with a pause of 200 milliseconds.

Constructor Summary

Constructors

Constructor and Description
Retriable()

Method Summary

Modifier and Type	Method and Description
abstract T	retriableCall() A method which contains a retriable call.
T	retryCallOnFail(int times, long timeout) Calls the retriableCall() ('the call') up to times times and returns the result.
protected void	waitTimeout(long timeout) Waits for specified number of milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

Retriable

public Retriable()

Method Detail

retriableCall

public abstract T retriableCall()
                         throws NoSuchAlgorithmException

A method which contains a retriable call. This method can throw a NoSuchAlgorithmException as it is meant to wrap calls from com.intuit.wasabi.authentication.impl.AuthenticationHelperss, which can throw these.

Returns:

An object of type T which should be retrieved with this call.

Throws:

NoSuchAlgorithmException - if the method used in this call throws such an exception.

waitTimeout

protected void waitTimeout(long timeout)
                    throws RetriableException

Waits for specified number of milliseconds.

Parameters:

timeout - sleep time in milliseconds.

Throws:

RetriableException - when sleep is interrupted

retryCallOnFail

public T retryCallOnFail(int times,
                         long timeout)
                  throws RetriableException

Calls the retriableCall() ('the call') up to times times and returns the result. If the call was successful, this method returns. If the call was not successful due to a missing implementation (throws NoSuchAlgorithmException), this method throws a RetriableException. If the call was not successful due to an UnknownHostException and the number of trials does not exceed times, this method retries the call after sleeping for timeout milliseconds. If the call was not successful and/or the number of trials is exceeded, this method throws a RetriableException.

Parameters:

times - the number of times this method should be called

timeout - the timeout in milliseconds

Returns:

the result of retriableCall()

Throws:

RetriableException - if retriableCall() throws or the maximum number of trials was reached