org.mule.runtime.core.api.retry.policy

Interface RetryPolicyTemplate

All Known Implementing Classes:

AbstractPolicyTemplate, AsynchronousRetryTemplate, NoRetryPolicyTemplate, SimpleRetryPolicyTemplate

@NoImplement
public interface RetryPolicyTemplate

A RetryPolicyTemplate creates a new RetryPolicy instance each time the retry goes into effect, thereby resetting any state the policy may have (counters, etc.) A RetryNotifier may be set in order to take action upon each retry attempt.

Method Summary

Modifier and Type	Method and Description
default <T> org.reactivestreams.Publisher<T>	applyPolicy(org.reactivestreams.Publisher<T> publisher) Applies the retry policy in a non blocking manner by transforming the given publisher into one configured to apply the retry logic.
default <T> org.reactivestreams.Publisher<T>	applyPolicy(org.reactivestreams.Publisher<T> publisher, Predicate<Throwable> shouldRetry, Consumer<Throwable> onExhausted, Function<Throwable,Throwable> errorFunction) Applies the retry policy in a non blocking manner by transforming the given publisher into one configured to apply the retry logic.
RetryPolicy	createRetryInstance()
RetryContext	execute(RetryCallback callback, Executor workManager) Applies the retry policy by performing a blocking action.
Map<Object,Object>	getMetaInfo()
RetryNotifier	getNotifier()
void	setMetaInfo(Map<Object,Object> metaInfo)
void	setNotifier(RetryNotifier retryNotifier)

Method Detail

createRetryInstance

RetryPolicy createRetryInstance()

getMetaInfo

Map<Object,Object> getMetaInfo()

setMetaInfo

void setMetaInfo(Map<Object,Object> metaInfo)

getNotifier

RetryNotifier getNotifier()

setNotifier

void setNotifier(RetryNotifier retryNotifier)

execute

RetryContext execute(RetryCallback callback,
                     Executor workManager)
              throws Exception

Applies the retry policy by performing a blocking action.

Parameters:

callback - a callback with the logic to be executed on each retry

workManager - the executor on which the retry operations are to be executed

Returns:

a RetryContext

Throws:

Exception

applyPolicy

default <T> org.reactivestreams.Publisher<T> applyPolicy(org.reactivestreams.Publisher<T> publisher)

Applies the retry policy in a non blocking manner by transforming the given publisher into one configured to apply the retry logic.

Type Parameters:

T - the generic type of the publisher's content

Parameters:

publisher - a publisher with the items which might fail

Returns:

a Publisher configured with the retry policy.

Since:

4.0

applyPolicy

default <T> org.reactivestreams.Publisher<T> applyPolicy(org.reactivestreams.Publisher<T> publisher,
                                                         Predicate<Throwable> shouldRetry,
                                                         Consumer<Throwable> onExhausted,
                                                         Function<Throwable,Throwable> errorFunction)

Applies the retry policy in a non blocking manner by transforming the given publisher into one configured to apply the retry logic.

Type Parameters:

T - the generic type of the publisher's content

Parameters:

publisher - a publisher with the items which might fail

shouldRetry - a predicate which evaluates each item to know if it should be retried or not

onExhausted - an action to perform when the retry action has been exhausted

errorFunction - function used to map cause exception to exception emitted by retry policy.

Returns:

a Publisher configured with the retry policy.

Since:

4.0