net.jodah.failsafe

Class AsyncExecution

java.lang.Object

net.jodah.failsafe.ExecutionContext

net.jodah.failsafe.AbstractExecution

net.jodah.failsafe.AsyncExecution

public final class AsyncExecution
extends AbstractExecution

Tracks asynchronous executions and allows retries to be scheduled according to a RetryPolicy. May be explicitly completed or made to retry.

Method Summary

Modifier and Type	Method and Description
void	complete() Completes the execution and the associated CompletableFuture.
boolean	complete(Object result) Attempts to complete the execution and the associated CompletableFuture with the result.
boolean	complete(Object result, Throwable failure) Attempts to complete the execution and the associated CompletableFuture with the result and failure.
boolean	retry() Records an execution if one has not been recorded yet, attempts to schedule a retry if necessary, and returns true if a retry has been scheduled else returns false and completes the execution and associated CompletableFuture.
boolean	retryFor(Object result) Records an execution if one has not been recorded yet for the result, attempts to schedule a retry if necessary, and returns true if a retry has been scheduled else returns false and completes the execution and associated CompletableFuture.
boolean	retryFor(Object result, Throwable failure) Records an execution if one has not been recorded yet for the result or failure, attempts to schedule a retry if necessary, and returns true if a retry has been scheduled else returns false and completes the execution and associated CompletableFuture.
boolean	retryOn(Throwable failure) Records an execution and returns true if a retry has been scheduled for the failure, else returns false and marks the execution and associated CompletableFuture as complete.

Methods inherited from class net.jodah.failsafe.AbstractExecution

getWaitTime, isComplete

Methods inherited from class net.jodah.failsafe.ExecutionContext

copy, getAttemptCount, getElapsedAttemptTime, getElapsedTime, getLastFailure, getLastResult, getLastResult, getStartTime, isCancelled, isFirstAttempt, isRetry, toString

Methods inherited from class java.lang.Object

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

Method Detail

complete

public void complete()

Completes the execution and the associated CompletableFuture.

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result)

Attempts to complete the execution and the associated CompletableFuture with the result. Returns true on success, else false if completion failed and the execution should be retried via retry().

Throws:

IllegalStateException - if the execution is already complete

complete

public boolean complete(Object result,
                        Throwable failure)

Attempts to complete the execution and the associated CompletableFuture with the result and failure. Returns true on success, else false if completion failed and the execution should be retried via retry().

Note: the execution may be completed even when the failure is not null, such as when the RetryPolicy does not allow retries for the failure.

Throws:

IllegalStateException - if the execution is already complete

retry

public boolean retry()

Records an execution if one has not been recorded yet, attempts to schedule a retry if necessary, and returns true if a retry has been scheduled else returns false and completes the execution and associated CompletableFuture.

Throws:

IllegalStateException - if a retry method has already been called or the execution is already complete

retryFor

public boolean retryFor(Object result)

Records an execution if one has not been recorded yet for the result, attempts to schedule a retry if necessary, and returns true if a retry has been scheduled else returns false and completes the execution and associated CompletableFuture.

Throws:

IllegalStateException - if a retry method has already been called or the execution is already complete

retryFor

public boolean retryFor(Object result,
                        Throwable failure)

Records an execution if one has not been recorded yet for the result or failure, attempts to schedule a retry if necessary, and returns true if a retry has been scheduled else returns false and completes the execution and associated CompletableFuture.

Throws:

IllegalStateException - if a retry method has already been called or the execution is already complete

retryOn

public boolean retryOn(Throwable failure)

Records an execution and returns true if a retry has been scheduled for the failure, else returns false and marks the execution and associated CompletableFuture as complete.

Throws:

NullPointerException - if failure is null

IllegalStateException - if a retry method has already been called or the execution is already complete