net.jodah.failsafe

Class FailsafeConfig<R,F>

java.lang.Object

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

Type Parameters:

R - result type

F - failsafe type - SyncFailsafe or AsyncFailsafe

Direct Known Subclasses:

AsyncFailsafeConfig, SyncFailsafe

public class FailsafeConfig<R,F>
extends Object

Failsafe configuration.

Method Summary

Modifier and Type	Method and Description
F	onAbort(CheckedBiConsumer<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution is aborted.
F	onAbort(CheckedConsumer<? extends Throwable> listener) Registers the listener to be called when an execution is aborted.
F	onAbort(ContextualResultListener<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution is aborted.
F	onAbortAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is aborted.
F	onAbortAsync(CheckedConsumer<? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is aborted.
F	onAbortAsync(ContextualResultListener<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is aborted.
F	onComplete(CheckedBiConsumer<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution is completed.
F	onComplete(ContextualResultListener<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution is completed.
F	onCompleteAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is completed.
F	onCompleteAsync(ContextualResultListener<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is completed.
F	onFailedAttempt(CheckedBiConsumer<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution attempt fails.
F	onFailedAttempt(CheckedConsumer<? extends Throwable> listener) Registers the listener to be called when an execution attempt fails.
F	onFailedAttempt(ContextualResultListener<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution attempt fails.
F	onFailedAttemptAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution attempt fails.
F	onFailedAttemptAsync(CheckedConsumer<? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution attempt fails.
F	onFailedAttemptAsync(ContextualResultListener<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution attempt fails.
F	onFailure(CheckedBiConsumer<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution fails and cannot be retried.
F	onFailure(CheckedConsumer<? extends Throwable> listener) Registers the listener to be called when an execution fails and cannot be retried.
F	onFailure(ContextualResultListener<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution fails and cannot be retried.
F	onFailureAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution fails and cannot be retried.
F	onFailureAsync(CheckedConsumer<? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution fails and cannot be retried.
F	onFailureAsync(ContextualResultListener<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution fails and cannot be retried.
F	onRetriesExceeded(CheckedBiConsumer<? extends R,? extends Throwable> listener) Registers the listener to be called when an execution fails and the max retry attempts or max duration are exceeded.
F	onRetriesExceeded(CheckedConsumer<? extends Throwable> listener) Registers the listener to be called when an execution fails and the max retry attempts or max duration are exceeded.
F	onRetriesExceededAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution fails and the max retry attempts or max duration are exceeded.
F	onRetriesExceededAsync(CheckedConsumer<? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution fails and the max retry attempts or max duration are exceeded.
F	onRetry(CheckedBiConsumer<? extends R,? extends Throwable> listener) Registers the listener to be called before an execution is retried.
F	onRetry(CheckedConsumer<? extends Throwable> listener) Registers the listener to be called before an execution is retried.
F	onRetry(ContextualResultListener<? extends R,? extends Throwable> listener) Registers the listener to be called before an execution is retried.
F	onRetryAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor before an execution is retried.
F	onRetryAsync(CheckedConsumer<? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor before an execution is retried.
F	onRetryAsync(ContextualResultListener<? extends R,? extends Throwable> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor before an execution is retried.
F	onSuccess(CheckedBiConsumer<? extends R,ExecutionContext> listener) Registers the listener to be called when an execution is successful.
F	onSuccess(CheckedConsumer<? extends R> listener) Registers the listener to be called when an execution is successful.
F	onSuccessAsync(CheckedBiConsumer<? extends R,ExecutionContext> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is successful.
F	onSuccessAsync(CheckedConsumer<? extends R> listener, ExecutorService executor) Registers the listener to be called asynchronously on the executor when an execution is successful.
F	with(CircuitBreaker circuitBreaker) Configures the circuitBreaker to be used to control the rate of event execution.
<T> F	with(Listeners<T> listeners) Configures the listeners to be called as execution events occur.
F	with(RetryPolicy retryPolicy) Configures the retryPolicy to be used for retrying failed executions.
F	withFallback(Callable<? extends R> fallback) Configures the fallback action to be executed if execution fails.
F	withFallback(CheckedBiConsumer<? extends R,? extends Throwable> fallback) Configures the fallback action to be executed if execution fails.
F	withFallback(CheckedBiFunction<? extends R,? extends Throwable,? extends R> fallback) Configures the fallback action to be executed if execution fails.
F	withFallback(CheckedConsumer<? extends Throwable> fallback) Configures the fallback action to be executed if execution fails.
F	withFallback(CheckedFunction<? extends Throwable,? extends R> fallback) Configures the fallback action to be executed if execution fails.
F	withFallback(CheckedRunnable fallback) Configures the fallback action to be executed if execution fails.
F	withFallback(R fallback) Configures the fallback result to be returned if execution fails.

Methods inherited from class java.lang.Object

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

Method Detail

onAbort

public F onAbort(CheckedBiConsumer<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution is aborted.

onAbort

public F onAbort(CheckedConsumer<? extends Throwable> listener)

Registers the listener to be called when an execution is aborted.

onAbort

public F onAbort(ContextualResultListener<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution is aborted.

onAbortAsync

public F onAbortAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener,
                      ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is aborted.

onAbortAsync

public F onAbortAsync(CheckedConsumer<? extends Throwable> listener,
                      ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is aborted.

onAbortAsync

public F onAbortAsync(ContextualResultListener<? extends R,? extends Throwable> listener,
                      ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is aborted.

onComplete

public F onComplete(CheckedBiConsumer<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution is completed.

onComplete

public F onComplete(ContextualResultListener<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution is completed.

onCompleteAsync

public F onCompleteAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener,
                         ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is completed.

onCompleteAsync

public F onCompleteAsync(ContextualResultListener<? extends R,? extends Throwable> listener,
                         ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is completed.

onFailedAttempt

public F onFailedAttempt(CheckedBiConsumer<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution attempt fails.

onFailedAttempt

public F onFailedAttempt(CheckedConsumer<? extends Throwable> listener)

Registers the listener to be called when an execution attempt fails.

onFailedAttempt

public F onFailedAttempt(ContextualResultListener<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution attempt fails.

onFailedAttemptAsync

public F onFailedAttemptAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener,
                              ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution attempt fails.

onFailedAttemptAsync

public F onFailedAttemptAsync(CheckedConsumer<? extends Throwable> listener,
                              ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution attempt fails.

onFailedAttemptAsync

public F onFailedAttemptAsync(ContextualResultListener<? extends R,? extends Throwable> listener,
                              ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution attempt fails.

onFailure

public F onFailure(CheckedBiConsumer<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution fails and cannot be retried.

onFailure

public F onFailure(CheckedConsumer<? extends Throwable> listener)

Registers the listener to be called when an execution fails and cannot be retried.

onFailure

public F onFailure(ContextualResultListener<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution fails and cannot be retried.

onFailureAsync

public F onFailureAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener,
                        ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution fails and cannot be retried.

onFailureAsync

public F onFailureAsync(CheckedConsumer<? extends Throwable> listener,
                        ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution fails and cannot be retried.

onFailureAsync

public F onFailureAsync(ContextualResultListener<? extends R,? extends Throwable> listener,
                        ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution fails and cannot be retried.

onRetriesExceeded

public F onRetriesExceeded(CheckedBiConsumer<? extends R,? extends Throwable> listener)

Registers the listener to be called when an execution fails and the max retry attempts or max duration are exceeded.

onRetriesExceeded

public F onRetriesExceeded(CheckedConsumer<? extends Throwable> listener)

Registers the listener to be called when an execution fails and the max retry attempts or max duration are exceeded.

onRetriesExceededAsync

public F onRetriesExceededAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener,
                                ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution fails and the max retry attempts or max duration are exceeded.

onRetriesExceededAsync

public F onRetriesExceededAsync(CheckedConsumer<? extends Throwable> listener,
                                ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution fails and the max retry attempts or max duration are exceeded.

onRetry

public F onRetry(CheckedBiConsumer<? extends R,? extends Throwable> listener)

Registers the listener to be called before an execution is retried.

onRetry

public F onRetry(CheckedConsumer<? extends Throwable> listener)

Registers the listener to be called before an execution is retried.

onRetry

public F onRetry(ContextualResultListener<? extends R,? extends Throwable> listener)

Registers the listener to be called before an execution is retried.

onRetryAsync

public F onRetryAsync(CheckedBiConsumer<? extends R,? extends Throwable> listener,
                      ExecutorService executor)

Registers the listener to be called asynchronously on the executor before an execution is retried.

onRetryAsync

public F onRetryAsync(CheckedConsumer<? extends Throwable> listener,
                      ExecutorService executor)

Registers the listener to be called asynchronously on the executor before an execution is retried.

onRetryAsync

public F onRetryAsync(ContextualResultListener<? extends R,? extends Throwable> listener,
                      ExecutorService executor)

Registers the listener to be called asynchronously on the executor before an execution is retried.

onSuccess

public F onSuccess(CheckedBiConsumer<? extends R,ExecutionContext> listener)

Registers the listener to be called when an execution is successful.

onSuccess

public F onSuccess(CheckedConsumer<? extends R> listener)

Registers the listener to be called when an execution is successful.

onSuccessAsync

public F onSuccessAsync(CheckedBiConsumer<? extends R,ExecutionContext> listener,
                        ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is successful.

onSuccessAsync

public F onSuccessAsync(CheckedConsumer<? extends R> listener,
                        ExecutorService executor)

Registers the listener to be called asynchronously on the executor when an execution is successful.

with

public F with(CircuitBreaker circuitBreaker)

Configures the circuitBreaker to be used to control the rate of event execution.

Throws:

NullPointerException - if circuitBreaker is null

IllegalStateException - if a circuit breaker is already configured

with

public <T> F with(Listeners<T> listeners)

Configures the listeners to be called as execution events occur.

Throws:

NullPointerException - if listeners is null

with

public F with(RetryPolicy retryPolicy)

Configures the retryPolicy to be used for retrying failed executions.

Throws:

NullPointerException - if retryPolicy is null

IllegalStateException - if a retry policy is already configured

withFallback

public F withFallback(Callable<? extends R> fallback)

Configures the fallback action to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called

withFallback

public F withFallback(CheckedBiConsumer<? extends R,? extends Throwable> fallback)

Configures the fallback action to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called

withFallback

public F withFallback(CheckedBiFunction<? extends R,? extends Throwable,? extends R> fallback)

Configures the fallback action to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called

withFallback

public F withFallback(CheckedConsumer<? extends Throwable> fallback)

Configures the fallback action to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called

withFallback

public F withFallback(CheckedFunction<? extends Throwable,? extends R> fallback)

Configures the fallback action to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called

withFallback

public F withFallback(CheckedRunnable fallback)

Configures the fallback action to be executed if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called

withFallback

public F withFallback(R fallback)

Configures the fallback result to be returned if execution fails.

Throws:

NullPointerException - if fallback is null

IllegalStateException - if withFallback method has already been called