net.jodah.failsafe

Class AsyncFailsafe<R>

java.lang.Object

net.jodah.failsafe.FailsafeConfig<R,F>

net.jodah.failsafe.AsyncFailsafeConfig<R,AsyncFailsafe<R>>

net.jodah.failsafe.AsyncFailsafe<R>

Type Parameters:

R - listener result type

public class AsyncFailsafe<R>
extends AsyncFailsafeConfig<R,AsyncFailsafe<R>>

Performs asynchronous executions with failures handled according to a configured retry policy, circuit breaker and fallback.

Method Summary

Modifier and Type	Method and Description
<T> CompletableFuture<T>	future(Callable<? extends CompletionStage<T>> callable) Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.
<T> CompletableFuture<T>	future(ContextualCallable<? extends CompletionStage<T>> callable) Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.
<T> CompletableFuture<T>	futureAsync(AsyncCallable<? extends CompletionStage<T>> callable) Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.
<T> FailsafeFuture<T>	get(Callable<T> callable) Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.
<T> FailsafeFuture<T>	get(ContextualCallable<T> callable) Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.
<T> FailsafeFuture<T>	getAsync(AsyncCallable<T> callable) Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.
FailsafeFuture<Void>	run(CheckedRunnable runnable) Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.
FailsafeFuture<Void>	run(ContextualRunnable runnable) Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.
FailsafeFuture<Void>	runAsync(AsyncRunnable runnable) Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.

Methods inherited from class net.jodah.failsafe.AsyncFailsafeConfig

onAbortAsync, onAbortAsync, onAbortAsync, onCompleteAsync, onCompleteAsync, onFailedAttemptAsync, onFailedAttemptAsync, onFailedAttemptAsync, onFailureAsync, onFailureAsync, onFailureAsync, onRetriesExceededAsync, onRetriesExceededAsync, onRetryAsync, onRetryAsync, onRetryAsync, onSuccessAsync, onSuccessAsync

Methods inherited from class net.jodah.failsafe.FailsafeConfig

onAbort, onAbort, onAbort, onAbortAsync, onAbortAsync, onAbortAsync, onComplete, onComplete, onCompleteAsync, onCompleteAsync, onFailedAttempt, onFailedAttempt, onFailedAttempt, onFailedAttemptAsync, onFailedAttemptAsync, onFailedAttemptAsync, onFailure, onFailure, onFailure, onFailureAsync, onFailureAsync, onFailureAsync, onRetriesExceeded, onRetriesExceeded, onRetriesExceededAsync, onRetriesExceededAsync, onRetry, onRetry, onRetry, onRetryAsync, onRetryAsync, onRetryAsync, onSuccess, onSuccess, onSuccessAsync, onSuccessAsync, with, with, with, withFallback, withFallback, withFallback, withFallback, withFallback, withFallback, withFallback

Methods inherited from class java.lang.Object

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

Method Detail

future

public <T> CompletableFuture<T> future(Callable<? extends CompletionStage<T>> callable)

Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.

If a configured circuit breaker is open, the resulting future is completed exceptionally with CircuitBreakerOpenException.

Supported on Java 8 and above.

Throws:

NullPointerException - if the callable is null

future

public <T> CompletableFuture<T> future(ContextualCallable<? extends CompletionStage<T>> callable)

Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.

If a configured circuit breaker is open, the resulting future is completed exceptionally with CircuitBreakerOpenException.

Supported on Java 8 and above.

Throws:

NullPointerException - if the callable is null

futureAsync

public <T> CompletableFuture<T> futureAsync(AsyncCallable<? extends CompletionStage<T>> callable)

Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded. This method is intended for integration with asynchronous code. Retries must be manually scheduled via one of the AsyncExecution.retry methods.

If a configured circuit breaker is open, the resulting future is completed exceptionally with CircuitBreakerOpenException.

Supported on Java 8 and above.

Throws:

NullPointerException - if the callable is null

get

public <T> FailsafeFuture<T> get(Callable<T> callable)

Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.

If a configured circuit breaker is open, the resulting future is completed with CircuitBreakerOpenException.

Throws:

NullPointerException - if the callable is null

get

public <T> FailsafeFuture<T> get(ContextualCallable<T> callable)

Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.

If a configured circuit breaker is open, the resulting future is completed with CircuitBreakerOpenException.

Throws:

NullPointerException - if the callable is null

getAsync

public <T> FailsafeFuture<T> getAsync(AsyncCallable<T> callable)

Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded. This method is intended for integration with asynchronous code. Retries must be manually scheduled via one of the AsyncExecution.retry methods.

If a configured circuit breaker is open, the resulting future is completed with CircuitBreakerOpenException.

Throws:

NullPointerException - if the callable is null

run

public FailsafeFuture<Void> run(CheckedRunnable runnable)

Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.

If a configured circuit breaker is open, the resulting future is completed with CircuitBreakerOpenException.

Throws:

NullPointerException - if the runnable is null

run

public FailsafeFuture<Void> run(ContextualRunnable runnable)

Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.

If a configured circuit breaker is open, the resulting future is completed with CircuitBreakerOpenException.

Throws:

NullPointerException - if the runnable is null

runAsync

public FailsafeFuture<Void> runAsync(AsyncRunnable runnable)

Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded. This method is intended for integration with asynchronous code. Retries must be manually scheduled via one of the AsyncExecution.retry methods.

If a configured circuit breaker is open, the resulting future is completed with CircuitBreakerOpenException.

Throws:

NullPointerException - if the runnable is null