com.couchbase.client.java.util.retry

Class RetryBuilder

java.lang.Object

com.couchbase.client.java.util.retry.RetryBuilder

@InterfaceStability.Committed
 @InterfaceAudience.Public
public class RetryBuilder
extends Object

Builder for RetryWhenFunction. Start with any(), anyOf(Class[]) or allBut(Class[]) factory methods.

By default, without calling additional methods it will retry on the specified exceptions, with a constant delay (see Retry.DEFAULT_DELAY), and only once.

Note that if retriable errors keep occurring more than the maximum allowed number of attempts, the last error that triggered the extraneous attempt will be wrapped as the cause inside a CannotRetryException, which will be emitted via the observable’s onError method.

Since:

2.1

Author:

Simon Baslé

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RetryBuilder.InversePredicate
static interface	RetryBuilder.OnRetryAction An interface alias for Action4<Integer, Throwable, Long, TimeUnit>, suitable for doOnRetry(Action4).
protected static class	RetryBuilder.ShouldStopOnError

Method Summary

Modifier and Type	Method and Description
static RetryBuilder	allBut(Class<? extends Throwable>... types) Only errors that are NOT instanceOf the specified types will trigger a retry
static RetryBuilder	any() Any error will trigger a retry
static RetryBuilder	anyMatches(Func1<Throwable,Boolean> retryErrorPredicate) Any error that pass the predicate will trigger a retry
static RetryBuilder	anyOf(Class<? extends Throwable>... types) Only errors that are instanceOf the specified types will trigger a retry
RetryWhenFunction	build() Construct the resulting RetryWhenFunction
RetryBuilder	delay(Delay delay) Customize the retry Delay
RetryBuilder	delay(Delay delay, Scheduler scheduler) Set both the Delay and the Scheduler on which the delay is waited.
RetryBuilder	delay(Scheduler scheduler) Use Retry.DEFAULT_DELAY but wait on a specific Scheduler
RetryBuilder	doOnRetry(Action4<Integer,Throwable,Long,TimeUnit> doOnRetryAction) Execute some code each time a retry is scheduled (at the moment the retriable exception is caught, but before the retry delay is applied).
RetryBuilder	max(int maxAttempts) Make at most maxAttempts retry attempts.
RetryBuilder	once() Make only one retry attempt (default).

Methods inherited from class java.lang.Object

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

Method Detail

anyOf

public static RetryBuilder anyOf(Class<? extends Throwable>... types)

Only errors that are instanceOf the specified types will trigger a retry

allBut

public static RetryBuilder allBut(Class<? extends Throwable>... types)

Only errors that are NOT instanceOf the specified types will trigger a retry

any

public static RetryBuilder any()

Any error will trigger a retry

anyMatches

public static RetryBuilder anyMatches(Func1<Throwable,Boolean> retryErrorPredicate)

Any error that pass the predicate will trigger a retry

once

public RetryBuilder once()

Make only one retry attempt (default).

If an error that can trigger a retry occurs twice in a row, it will be wrapped as the cause inside a CannotRetryException, which will be emitted via the observable’s onError method.

max

public RetryBuilder max(int maxAttempts)

Make at most maxAttempts retry attempts.

Note that the maximum accepted value is Integer.MAX_VALUE - 1, the internal retry mechanism will ensure a total of maxAttempts + 1 total attempts, accounting for the original call.

If an error that can trigger a retry occurs more that maxAttempts, it will be wrapped as the cause inside a CannotRetryException, which will be emitted via the observable’s onError method.

delay

public RetryBuilder delay(Delay delay)

Customize the retry Delay

delay

public RetryBuilder delay(Scheduler scheduler)

Use Retry.DEFAULT_DELAY but wait on a specific Scheduler

delay

public RetryBuilder delay(Delay delay,
                          Scheduler scheduler)

Set both the Delay and the Scheduler on which the delay is waited. If the delay is null, Retry.DEFAULT_DELAY is used.

doOnRetry

public RetryBuilder doOnRetry(Action4<Integer,Throwable,Long,TimeUnit> doOnRetryAction)

Execute some code each time a retry is scheduled (at the moment the retriable exception is caught, but before the retry delay is applied). Only quick executing code should be performed, do not block in this action.

The action receives the retry attempt number (1-n), the exception that caused the retry, the delay duration and timeunit for the scheduled retry.

Parameters:

doOnRetryAction - the side-effect action to perform whenever a retry is scheduled.

See Also:

if you want a shorter signature.

build

public RetryWhenFunction build()

Construct the resulting RetryWhenFunction