Package dev.failsafe.okhttp

Class FailsafeCall

java.lang.Object

dev.failsafe.okhttp.FailsafeCall

public final class FailsafeCall
extends Object

A Failsafe wrapped OkHttp Call. Supports synchronous and asynchronous executions, and cancellation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FailsafeCall.FailsafeCallBuilder

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels the call.
FailsafeCall	clone()	Returns a clone of the FailsafeCall.
okhttp3.Response	execute()	Executes the call until a successful response is returned or the configured policies are exceeded.
CompletableFuture<okhttp3.Response>	executeAsync()	Executes the call asynchronously until a successful result is returned or the configured policies are exceeded.
boolean	isCancelled()	Returns whether the call has been cancelled.
boolean	isExecuted()	Returns whether the call has been executed.
static FailsafeCall.FailsafeCallBuilder	with(FailsafeExecutor<okhttp3.Response> failsafeExecutor)	Returns a FailsafeCallBuilder for the failsafeExecutor.
static <P extends Policy<okhttp3.Response>> FailsafeCall.FailsafeCallBuilder	with(P outerPolicy, P... policies)	Returns a FailsafeCallBuilder for the outerPolicy and policies.

Methods inherited from class java.lang.Object

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

Method Detail

with

@SafeVarargs
public static <P extends Policy<okhttp3.Response>> FailsafeCall.FailsafeCallBuilder with(P outerPolicy,
                                                                                         P... policies)

Returns a FailsafeCallBuilder for the outerPolicy and policies. See Failsafe.with(Policy, Policy[]) for docs on how policy composition works.

Type Parameters:

P - policy type

Throws:

NullPointerException - if call or outerPolicy are null

with

public static FailsafeCall.FailsafeCallBuilder with(FailsafeExecutor<okhttp3.Response> failsafeExecutor)

Returns a FailsafeCallBuilder for the failsafeExecutor.

Throws:

NullPointerException - if failsafeExecutor is null

cancel

public void cancel()

Cancels the call.

clone

public FailsafeCall clone()

Returns a clone of the FailsafeCall.

Overrides:

clone in class Object

execute

public okhttp3.Response execute()
                         throws IOException

Executes the call until a successful response is returned or the configured policies are exceeded. To avoid leaking resources callers should close the Response which in turn will close the underlying ResponseBody.

Throws:

IllegalStateException - if the call has already been executed

IOException - if the request could not be executed due to cancellation, a connectivity problem, or timeout

FailsafeException - if the execution fails with a checked Exception. Throwable.getCause() can be used to learn the underlying checked exception.

executeAsync

public CompletableFuture<okhttp3.Response> executeAsync()

Executes the call asynchronously until a successful result is returned or the configured policies are exceeded. To avoid leaking resources callers should close the Response which in turn will close the underlying ResponseBody.

isCancelled

public boolean isCancelled()

Returns whether the call has been cancelled.

isExecuted

public boolean isExecuted()

Returns whether the call has been executed.