Package com.broadleafcommerce.dataexchange.domain.util

Class Retryable.RetryableBuilder<X>

java.lang.Object

com.broadleafcommerce.dataexchange.domain.util.Retryable.RetryableBuilder<X>

Type Parameters:

X -

Enclosing class:

Retryable<X>

public static class Retryable.RetryableBuilder<X>
extends Object

Builder to assist in building a Retryable.

Constructor Summary

Constructors

Constructor	Description
RetryableBuilder()

Method Summary

Modifier and Type	Method	Description
Retryable<X>	build()	Returns am instance of Retryable based on this Retryable.RetryableBuilder.
Callable<X>	buildCallable()	Convenient build method to return this instance as a Callable.
Runnable	buildRunnable()	Convenient build method to return this instance as a Runnable.
Supplier<X>	buildSupplier()	Convenient build method to return this instance as a Supplier.
Retryable.RetryableBuilder<X>	withCallable(Callable<X> callable)	Implementation of a Callable functional interface or lambda.
Retryable.RetryableBuilder<X>	withDefaultRetryTemplate()	Use a RetryTemplate that will execute no more than 3 tries (2 retries), using the Retryable.defaultRetryPredicate(Predicate) and a conservative back-off policy that will not exceed 50 ms.
Retryable.RetryableBuilder<X>	withExceptionConsumer(ExchangeObject exchangeObject, BatchContext<?> batchContext)	Creates a Consumer that calls BatchContext.registerException(String, Throwable) using the ExchangeObject.getCorrelationId() as the key and logs the exception.
Retryable.RetryableBuilder<X>	withRethrowingExceptionConsumer()	Creates a default Consumer implementation that simply throws a RuntimeException with the provided exception as the cause.
Retryable.RetryableBuilder<X>	withRetryTemplate(org.springframework.retry.support.RetryTemplate rt)	Use the provided RetryTemplate for retry semantics.
Retryable.RetryableBuilder<X>	withRunnable(Runnable runnable)
Retryable.RetryableBuilder<X>	withSupplier(Supplier<X> supplier)

Methods inherited from class java.lang.Object

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

Constructor Details

RetryableBuilder

public RetryableBuilder()

Method Details

withCallable

public Retryable.RetryableBuilder<X> withCallable(@NonNull
 Callable<X> callable)

Implementation of a Callable functional interface or lambda. This should be a rather short-lived or discrete, idempotent unit of work, since the whole point of this is to retry the execution of this callable in the event that errors are encountered.

Parameters:

callable - the short, discrete, idempotent function to execute

Returns:

the result of the execution of the provided Callable

withSupplier

public Retryable.RetryableBuilder<X> withSupplier(@NonNull
 Supplier<X> supplier)

withRunnable

public Retryable.RetryableBuilder<X> withRunnable(@NonNull
 Runnable runnable)

withDefaultRetryTemplate

public Retryable.RetryableBuilder<X> withDefaultRetryTemplate()

Use a RetryTemplate that will execute no more than 3 tries (2 retries), using the Retryable.defaultRetryPredicate(Predicate) and a conservative back-off policy that will not exceed 50 ms.

Returns:

this Retryable.RetryableBuilder for fluent chaining

withRetryTemplate

public Retryable.RetryableBuilder<X> withRetryTemplate(@NonNull
 org.springframework.retry.support.RetryTemplate rt)

Use the provided RetryTemplate for retry semantics.

Parameters:

rt - the provided RetryTemplate

Returns:

this Retryable.RetryableBuilder for fluent chaining

withRethrowingExceptionConsumer

public Retryable.RetryableBuilder<X> withRethrowingExceptionConsumer()

Creates a default Consumer implementation that simply throws a RuntimeException with the provided exception as the cause.

Returns:

this Retryable.RetryableBuilder for fluent chaining

withExceptionConsumer

public Retryable.RetryableBuilder<X> withExceptionConsumer(ExchangeObject exchangeObject,
 BatchContext<?> batchContext)

Creates a Consumer that calls BatchContext.registerException(String, Throwable) using the ExchangeObject.getCorrelationId() as the key and logs the exception.

Parameters:

exchangeObject - used to provide the key to the Map

batchContext - the container that holds Exceptions for each ExchangeObject

Returns:

this Retryable.RetryableBuilder for fluent chaining

build

public Retryable<X> build()

Returns am instance of Retryable based on this Retryable.RetryableBuilder. Retryable implements Callable, Supplier, and Runnable, and executes each of them similarly, except for the return semantics and/or the throws semantics. If no RetryTemplate is provided, then a default will be used. If not exception Consumer is provided, a default logging consumer will be used. The Callable delegate is required to be provided.

Returns:

Retryable instance

See Also:

• buildCallable()
• buildRunnable()
• buildSupplier()

buildSupplier

public Supplier<X> buildSupplier()

Convenient build method to return this instance as a Supplier. Alias for build().

Returns:

Retryable as a Supplier

See Also:

• build()
• buildRunnable()
• buildCallable()

buildRunnable

public Runnable buildRunnable()

Convenient build method to return this instance as a Runnable. Alias for build().

Returns:

Retryable as a Runnable

See Also:

• build()
• buildSupplier()
• buildCallable()

buildCallable

public Callable<X> buildCallable()

Convenient build method to return this instance as a Callable. Alias for build().

Returns:

Retryable as a Callable

See Also:

• build()
• buildRunnable()
• buildSupplier()