Module io.helidon.faulttolerance

Package io.helidon.faulttolerance

Class Retry.Builder

java.lang.Object

io.helidon.faulttolerance.Retry.Builder

All Implemented Interfaces:

Builder<Retry>, Supplier<Retry>

Enclosing interface:

Retry

public static class Retry.Builder
extends Object
implements Builder<Retry>

Fluent API builder for Retry.

Method Summary

Modifier and Type	Method	Description
Retry.Builder	addApplyOn(Class<? extends Throwable> clazz)	Add a throwable to be considered a failure.
Retry.Builder	addSkipOn(Class<? extends Throwable> clazz)	This throwable will not be considered retriable.
Retry.Builder	applyOn(Class<? extends Throwable>... classes)	These throwables will be considered failures, and all other will not.
Retry	build()	Build the instance from this builder.
Retry.Builder	overallTimeout(Duration overallTimeout)	Overall timeout.
Retry.Builder	retryPolicy(Retry.RetryPolicy policy)	Configure a retry policy to use to calculate delays between retries.
Retry.Builder	scheduledExecutor(ScheduledExecutorService scheduledExecutor)	Executor service to schedule retries.
Retry.Builder	skipOn(Class<? extends Throwable>... classes)	These throwables will not be considered retriable, all other will.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

build

public Retry build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<Retry>

Returns:

instance of the built type

retryPolicy

public Retry.Builder retryPolicy(Retry.RetryPolicy policy)

Configure a retry policy to use to calculate delays between retries. Defaults to a Retry.JitterRetryPolicy with 4 calls (initial call + 3 retries), delay of 200 millis and a jitter of 50 millis.

Parameters:

policy - retry policy

Returns:

updated builder instance

applyOn

public Retry.Builder applyOn(Class<? extends Throwable>... classes)

These throwables will be considered failures, and all other will not.

Cannot be combined with skipOn.

Parameters:

classes - to consider failures and trigger a retry

Returns:

updated builder instance

addApplyOn

public Retry.Builder addApplyOn(Class<? extends Throwable> clazz)

Add a throwable to be considered a failure.

Parameters:

clazz - to consider failure and trigger a retry

Returns:

updated builder instance

See Also:

applyOn

skipOn

public Retry.Builder skipOn(Class<? extends Throwable>... classes)

These throwables will not be considered retriable, all other will.

Cannot be combined with applyOn.

Parameters:

classes - to skip retries

Returns:

updated builder instance

addSkipOn

public Retry.Builder addSkipOn(Class<? extends Throwable> clazz)

This throwable will not be considered retriable.

Parameters:

clazz - to to skip retries

Returns:

updated builder instance

scheduledExecutor

public Retry.Builder scheduledExecutor(ScheduledExecutorService scheduledExecutor)

Executor service to schedule retries. By default uses an executor configured on FaultTolerance.scheduledExecutor(java.util.function.Supplier).

Parameters:

scheduledExecutor - executor to use

Returns:

updated builder instance

overallTimeout

public Retry.Builder overallTimeout(Duration overallTimeout)

Overall timeout. When overall timeout is reached, execution terminates (even if the retry policy was not exhausted).

Parameters:

overallTimeout - an overall timeout

Returns:

updated builder instance