org.cripac.isee.vpe.common

Class RobustExecutor<T,R>

java.lang.Object

org.cripac.isee.vpe.common.RobustExecutor<T,R>

public class RobustExecutor<T,R>
extends Object

The class RobustExecutor execute functions and automatically retry on failure. It is recommended to only wrap codes that can easily fail, and retrying might possibly fix the problem.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RobustExecutor.VoidFunction0

Field Summary

Fields

Modifier and Type	Field and Description
private int	maxRetries
private List<Class<?>>	noRetryThrowables
private org.apache.spark.api.java.function.Function<T,R>	onceFunction
private int	retryInterval

Constructor Summary

Constructors

Constructor and Description
RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction, int maxRetries) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction, int maxRetries, int retryInterval) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction, int maxRetries, int retryInterval, List<Class<?>> noRetryThrowables) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction, List<Class<?>> noRetryThrowables) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.Function0<R> onceFunction) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(RobustExecutor.VoidFunction0 onceFunction) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(RobustExecutor.VoidFunction0 onceFunction, List<Class<?>> noRetryThrowables) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.VoidFunction<T> onceFunction) Create a RobustExecutor specifying the retrying behaviour.
RobustExecutor(org.apache.spark.api.java.function.VoidFunction<T> onceFunction, List<Class<?>> noRetryThrowables) Create a RobustExecutor specifying the retrying behaviour.

Method Summary

Modifier and Type	Method and Description
R	execute() Execute the specified function with no parameter robustly.
R	execute(T param) Execute the specified function robustly.

Methods inherited from class java.lang.Object

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

Field Detail

maxRetries

private final int maxRetries

retryInterval

private final int retryInterval

onceFunction

private org.apache.spark.api.java.function.Function<T,R> onceFunction

noRetryThrowables

private List<Class<?>> noRetryThrowables

Constructor Detail

RobustExecutor

public RobustExecutor(RobustExecutor.VoidFunction0 onceFunction)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times).

Parameters:

onceFunction - function to be executed each time.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.VoidFunction<T> onceFunction)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times).

Parameters:

onceFunction - function to be executed each time.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.Function0<R> onceFunction)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times). Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Parameters:

onceFunction - function to be executed each time.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times). Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Parameters:

onceFunction - function to be executed each time.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction,
                      int maxRetries)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure. Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Parameters:

onceFunction - function to be executed each time.

maxRetries - max times of retrying.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction,
                      int maxRetries,
                      int retryInterval)

Create a RobustExecutor specifying the retrying behaviour. Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Parameters:

onceFunction - function to be executed each time.

maxRetries - max times of retrying.

retryInterval - interval (ms) between retries.

RobustExecutor

public RobustExecutor(RobustExecutor.VoidFunction0 onceFunction,
                      List<Class<?>> noRetryThrowables)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times).

Parameters:

onceFunction - function to be executed each time.

noRetryThrowables - exceptions that are not able to be solved by retrying.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.VoidFunction<T> onceFunction,
                      List<Class<?>> noRetryThrowables)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times).

Parameters:

onceFunction - function to be executed each time.

noRetryThrowables - exceptions that are not able to be solved by retrying.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction,
                      List<Class<?>> noRetryThrowables)

Create a RobustExecutor specifying the retrying behaviour. The executor retries immediately after failure, and may retry up to 2 times (totally executing 3 times).

Parameters:

onceFunction - function to be executed each time.

noRetryThrowables - exceptions that are not able to be solved by retrying.

RobustExecutor

public RobustExecutor(org.apache.spark.api.java.function.Function<T,R> onceFunction,
                      int maxRetries,
                      int retryInterval,
                      List<Class<?>> noRetryThrowables)

Create a RobustExecutor specifying the retrying behaviour. Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Parameters:

maxRetries - max times of retrying.

retryInterval - interval (ms) between retries.

noRetryThrowables - exceptions that are not able to be solved by retrying.

Method Detail

execute

@Nonnull
public R execute()
                   throws Exception

Execute the specified function with no parameter robustly. When catching exceptions from the function, retry the execution. When reaching the max retrying times, throw the exception to handle outside. Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Throws:

Exception - On failure that cannot be handled by retrying.

execute

@Nonnull
public R execute(@Nullable
                          T param)
                   throws Exception

Execute the specified function robustly. When catching exceptions from the function, retry the execution. When reaching the max retrying times, throw the exception to handle outside. Note that be careful when simplifying the lambda expression for the function here, you may not get the correct function type as expected, resulting in null return value.

Throws:

Exception - On failure that cannot be handled by retrying.