net.jodah.failsafe

Class PolicyExecutor<P extends Policy>

java.lang.Object

net.jodah.failsafe.PolicyExecutor<P>

Type Parameters:

P - policy type

public abstract class PolicyExecutor<P extends Policy>
extends Object

Handles execution and execution results according to a policy. May contain pre and post execution behaviors. Each PolicyExecutor makes its own determination about whether an execution result is a success or failure.

Part of the Failsafe SPI.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractExecution	execution
protected P	policy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PolicyExecutor(P policy, AbstractExecution execution)

Method Summary

Modifier and Type	Method and Description
protected boolean	isFailure(ExecutionResult result) Returns whether the result is a success according to the policy.
protected ExecutionResult	onFailure(ExecutionResult result) Performs post-execution handling for a result that is considered a failure according to isFailure(ExecutionResult), possibly creating a new result, else returning the original result.
protected CompletableFuture<ExecutionResult>	onFailureAsync(ExecutionResult result, Scheduler scheduler, FailsafeFuture<Object> future) Performs potentially asynchrononus post-execution handling for a failed result, possibly creating a new result, else returning the original result.
protected void	onSuccess(ExecutionResult result) Performs post-execution handling for a result that is considered a success according to isFailure(ExecutionResult).
protected ExecutionResult	postExecute(ExecutionResult result) Performs synchronous post-execution handling for a result.
protected CompletableFuture<ExecutionResult>	postExecuteAsync(ExecutionResult result, Scheduler scheduler, FailsafeFuture<Object> future) Performs potentially asynchronous post-execution handling for a result.
protected ExecutionResult	preExecute() Called before execution to return an alternative result or failure such as if execution is not allowed or needed.
protected Supplier<ExecutionResult>	supply(Supplier<ExecutionResult> supplier, Scheduler scheduler) Performs an execution by calling pre-execute else calling the supplier and doing a post-execute.
protected Supplier<CompletableFuture<ExecutionResult>>	supplyAsync(Supplier<CompletableFuture<ExecutionResult>> supplier, Scheduler scheduler, FailsafeFuture<Object> future) Performs an async execution by calling pre-execute else calling the supplier and doing a post-execute.

Methods inherited from class java.lang.Object

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

Field Detail

policy

protected final P extends Policy policy

execution

protected final AbstractExecution execution

Constructor Detail

PolicyExecutor

protected PolicyExecutor(P policy,
                         AbstractExecution execution)

Method Detail

preExecute

protected ExecutionResult preExecute()

Called before execution to return an alternative result or failure such as if execution is not allowed or needed. Should return the provided result else some alternative.

supply

protected Supplier<ExecutionResult> supply(Supplier<ExecutionResult> supplier,
                                           Scheduler scheduler)

Performs an execution by calling pre-execute else calling the supplier and doing a post-execute.

postExecute

protected ExecutionResult postExecute(ExecutionResult result)

Performs synchronous post-execution handling for a result.

supplyAsync

protected Supplier<CompletableFuture<ExecutionResult>> supplyAsync(Supplier<CompletableFuture<ExecutionResult>> supplier,
                                                                   Scheduler scheduler,
                                                                   FailsafeFuture<Object> future)

Performs an async execution by calling pre-execute else calling the supplier and doing a post-execute.

postExecuteAsync

protected CompletableFuture<ExecutionResult> postExecuteAsync(ExecutionResult result,
                                                              Scheduler scheduler,
                                                              FailsafeFuture<Object> future)

Performs potentially asynchronous post-execution handling for a result.

isFailure

protected boolean isFailure(ExecutionResult result)

Returns whether the result is a success according to the policy. If the {code result} has no result, it is not a failure.

onSuccess

protected void onSuccess(ExecutionResult result)

Performs post-execution handling for a result that is considered a success according to isFailure(ExecutionResult).

onFailure

protected ExecutionResult onFailure(ExecutionResult result)

Performs post-execution handling for a result that is considered a failure according to isFailure(ExecutionResult), possibly creating a new result, else returning the original result.

onFailureAsync

protected CompletableFuture<ExecutionResult> onFailureAsync(ExecutionResult result,
                                                            Scheduler scheduler,
                                                            FailsafeFuture<Object> future)

Performs potentially asynchrononus post-execution handling for a failed result, possibly creating a new result, else returning the original result.