com.vmware.vapi.bindings.client

Interface RetryPolicy

public interface RetryPolicy

Client-side policy which decides what to do when an error happens during an API invocation.

This policy can be used it to automatically recover from temporary problems like expired sessions, service unavailable, network issues.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RetryPolicy.RetryContext Context about an invocation.
static class	RetryPolicy.RetrySpec Retry specification.

Method Summary

Methods

Modifier and Type	Method and Description
RetryPolicy.RetrySpec	onInvocationError(RuntimeException error, RetryPolicy.RetryContext retryContext, int invocationAttempt) An invocation error has occurred.

Method Detail

onInvocationError

RetryPolicy.RetrySpec onInvocationError(RuntimeException error,
                                      RetryPolicy.RetryContext retryContext,
                                      int invocationAttempt)

An invocation error has occurred. The policy should decide whether to retry the invocation or let it fail.

The error can be any exception that can be reported by the stub. See AsyncCallback.onError(RuntimeException) for details on possible errors.

The method is expected to return a retry specification. This specification will be used to retry the invocation. If the method returns null, there will be no further attempts and the invocation will fail.

Parameters:

error - invocation error; must not be null

retryContext - context about the invocation error; must not be null

invocationAttempt - number of the invocation attempt; first attempt is 0, second attempt (after error on retry) is 1, etc.; must not be null

Returns:

retry specification; null means no retry