Search in sources :

Example 1 with BackOffContext

use of cn.taketoday.retry.backoff.BackOffContext in project today-infrastructure by TAKETODAY.

the class RetryTemplate method doExecute.

/**
 * Execute the callback once if the policy dictates that we can, otherwise execute the
 * recovery callback.
 *
 * @param recoveryCallback the {@link RecoveryCallback}
 * @param retryCallback the {@link RetryCallback}
 * @param state the {@link RetryState}
 * @param <T> the type of the return value
 * @param <E> the exception type to throw
 * @return T the retried value
 * @throws ExhaustedRetryException if the retry has been exhausted.
 * @throws E an exception if the retry operation fails
 * @see RetryOperations#execute(RetryCallback, RecoveryCallback, RetryState)
 */
protected <T, E extends Throwable> T doExecute(RetryCallback<T, E> retryCallback, RecoveryCallback<T> recoveryCallback, RetryState state) throws E, ExhaustedRetryException {
    RetryPolicy retryPolicy = this.retryPolicy;
    BackOffPolicy backOffPolicy = this.backOffPolicy;
    // Allow the retry policy to initialise itself...
    RetryContext context = open(retryPolicy, state);
    if (logger.isTraceEnabled()) {
        logger.trace("RetryContext retrieved: {}", context);
    }
    // Make sure the context is available globally for clients who need
    // it...
    RetrySynchronizationManager.register(context);
    Throwable lastException = null;
    boolean exhausted = false;
    try {
        // Give clients a chance to enhance the context...
        boolean running = doOpenInterceptors(retryCallback, context);
        if (!running) {
            throw new TerminatedRetryException("Retry terminated abnormally by interceptor before first attempt");
        }
        // Get or Start the backoff context...
        BackOffContext backOffContext = null;
        Object resource = context.getAttribute("backOffContext");
        if (resource instanceof BackOffContext) {
            backOffContext = (BackOffContext) resource;
        }
        if (backOffContext == null) {
            backOffContext = backOffPolicy.start(context);
            if (backOffContext != null) {
                context.setAttribute("backOffContext", backOffContext);
            }
        }
        /*
       * We allow the whole loop to be skipped if the policy or context already
       * forbid the first try. This is used in the case of external retry to allow a
       * recovery in handleRetryExhausted without the callback processing (which
       * would throw an exception).
       */
        while (canRetry(retryPolicy, context) && !context.isExhaustedOnly()) {
            try {
                if (logger.isDebugEnabled()) {
                    logger.debug("Retry: count={}", context.getRetryCount());
                }
                // Reset the last exception, so if we are successful
                // the close interceptors will not think we failed...
                lastException = null;
                return retryCallback.doWithRetry(context);
            } catch (Throwable e) {
                lastException = e;
                try {
                    registerThrowable(retryPolicy, state, context, e);
                } catch (Exception ex) {
                    throw new TerminatedRetryException("Could not register throwable", ex);
                } finally {
                    doOnErrorInterceptors(retryCallback, context, e);
                }
                if (canRetry(retryPolicy, context) && !context.isExhaustedOnly()) {
                    try {
                        backOffPolicy.backOff(backOffContext);
                    } catch (BackOffInterruptedException ex) {
                        lastException = e;
                        // back off was prevented by another thread - fail the retry
                        if (logger.isDebugEnabled()) {
                            logger.debug("Abort retry because interrupted: count={}", context.getRetryCount());
                        }
                        throw ex;
                    }
                }
                if (logger.isDebugEnabled()) {
                    logger.debug("Checking for rethrow: count={}", context.getRetryCount());
                }
                if (shouldRethrow(retryPolicy, context, state)) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Rethrow in retry for policy: count={}", context.getRetryCount());
                    }
                    throw RetryTemplate.<E>wrapIfNecessary(e);
                }
            }
            /*
         * A stateful attempt that can retry may rethrow the exception before now,
         * but if we get this far in a stateful retry there's a reason for it,
         * like a circuit breaker or a rollback classifier.
         */
            if (state != null && context.hasAttribute(GLOBAL_STATE)) {
                break;
            }
        }
        if (state == null && logger.isDebugEnabled()) {
            logger.debug("Retry failed last attempt: count={}", context.getRetryCount());
        }
        exhausted = true;
        return handleRetryExhausted(recoveryCallback, context, state);
    } catch (Throwable e) {
        throw RetryTemplate.<E>wrapIfNecessary(e);
    } finally {
        close(retryPolicy, context, state, lastException == null || exhausted);
        doCloseInterceptors(retryCallback, context, lastException);
        RetrySynchronizationManager.clear();
    }
}
Also used : BackOffPolicy(cn.taketoday.retry.backoff.BackOffPolicy) NoBackOffPolicy(cn.taketoday.retry.backoff.NoBackOffPolicy) BackOffContext(cn.taketoday.retry.backoff.BackOffContext) RetryContext(cn.taketoday.retry.RetryContext) BackOffInterruptedException(cn.taketoday.retry.backoff.BackOffInterruptedException) RetryPolicy(cn.taketoday.retry.RetryPolicy) SimpleRetryPolicy(cn.taketoday.retry.policy.SimpleRetryPolicy) TerminatedRetryException(cn.taketoday.retry.TerminatedRetryException) ExhaustedRetryException(cn.taketoday.retry.ExhaustedRetryException) BackOffInterruptedException(cn.taketoday.retry.backoff.BackOffInterruptedException) RetryException(cn.taketoday.retry.RetryException) TerminatedRetryException(cn.taketoday.retry.TerminatedRetryException)

Example 2 with BackOffContext

use of cn.taketoday.retry.backoff.BackOffContext in project today-framework by TAKETODAY.

the class RetryTemplate method doExecute.

/**
 * Execute the callback once if the policy dictates that we can, otherwise execute the
 * recovery callback.
 *
 * @param recoveryCallback the {@link RecoveryCallback}
 * @param retryCallback the {@link RetryCallback}
 * @param state the {@link RetryState}
 * @param <T> the type of the return value
 * @param <E> the exception type to throw
 * @return T the retried value
 * @throws ExhaustedRetryException if the retry has been exhausted.
 * @throws E an exception if the retry operation fails
 * @see RetryOperations#execute(RetryCallback, RecoveryCallback, RetryState)
 */
protected <T, E extends Throwable> T doExecute(RetryCallback<T, E> retryCallback, RecoveryCallback<T> recoveryCallback, RetryState state) throws E, ExhaustedRetryException {
    RetryPolicy retryPolicy = this.retryPolicy;
    BackOffPolicy backOffPolicy = this.backOffPolicy;
    // Allow the retry policy to initialise itself...
    RetryContext context = open(retryPolicy, state);
    if (logger.isTraceEnabled()) {
        logger.trace("RetryContext retrieved: {}", context);
    }
    // Make sure the context is available globally for clients who need
    // it...
    RetrySynchronizationManager.register(context);
    Throwable lastException = null;
    boolean exhausted = false;
    try {
        // Give clients a chance to enhance the context...
        boolean running = doOpenInterceptors(retryCallback, context);
        if (!running) {
            throw new TerminatedRetryException("Retry terminated abnormally by interceptor before first attempt");
        }
        // Get or Start the backoff context...
        BackOffContext backOffContext = null;
        Object resource = context.getAttribute("backOffContext");
        if (resource instanceof BackOffContext) {
            backOffContext = (BackOffContext) resource;
        }
        if (backOffContext == null) {
            backOffContext = backOffPolicy.start(context);
            if (backOffContext != null) {
                context.setAttribute("backOffContext", backOffContext);
            }
        }
        /*
       * We allow the whole loop to be skipped if the policy or context already
       * forbid the first try. This is used in the case of external retry to allow a
       * recovery in handleRetryExhausted without the callback processing (which
       * would throw an exception).
       */
        while (canRetry(retryPolicy, context) && !context.isExhaustedOnly()) {
            try {
                if (logger.isDebugEnabled()) {
                    logger.debug("Retry: count={}", context.getRetryCount());
                }
                // Reset the last exception, so if we are successful
                // the close interceptors will not think we failed...
                lastException = null;
                return retryCallback.doWithRetry(context);
            } catch (Throwable e) {
                lastException = e;
                try {
                    registerThrowable(retryPolicy, state, context, e);
                } catch (Exception ex) {
                    throw new TerminatedRetryException("Could not register throwable", ex);
                } finally {
                    doOnErrorInterceptors(retryCallback, context, e);
                }
                if (canRetry(retryPolicy, context) && !context.isExhaustedOnly()) {
                    try {
                        backOffPolicy.backOff(backOffContext);
                    } catch (BackOffInterruptedException ex) {
                        lastException = e;
                        // back off was prevented by another thread - fail the retry
                        if (logger.isDebugEnabled()) {
                            logger.debug("Abort retry because interrupted: count={}", context.getRetryCount());
                        }
                        throw ex;
                    }
                }
                if (logger.isDebugEnabled()) {
                    logger.debug("Checking for rethrow: count={}", context.getRetryCount());
                }
                if (shouldRethrow(retryPolicy, context, state)) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Rethrow in retry for policy: count={}", context.getRetryCount());
                    }
                    throw RetryTemplate.<E>wrapIfNecessary(e);
                }
            }
            /*
         * A stateful attempt that can retry may rethrow the exception before now,
         * but if we get this far in a stateful retry there's a reason for it,
         * like a circuit breaker or a rollback classifier.
         */
            if (state != null && context.hasAttribute(GLOBAL_STATE)) {
                break;
            }
        }
        if (state == null && logger.isDebugEnabled()) {
            logger.debug("Retry failed last attempt: count={}", context.getRetryCount());
        }
        exhausted = true;
        return handleRetryExhausted(recoveryCallback, context, state);
    } catch (Throwable e) {
        throw RetryTemplate.<E>wrapIfNecessary(e);
    } finally {
        close(retryPolicy, context, state, lastException == null || exhausted);
        doCloseInterceptors(retryCallback, context, lastException);
        RetrySynchronizationManager.clear();
    }
}
Also used : BackOffPolicy(cn.taketoday.retry.backoff.BackOffPolicy) NoBackOffPolicy(cn.taketoday.retry.backoff.NoBackOffPolicy) BackOffContext(cn.taketoday.retry.backoff.BackOffContext) RetryContext(cn.taketoday.retry.RetryContext) BackOffInterruptedException(cn.taketoday.retry.backoff.BackOffInterruptedException) RetryPolicy(cn.taketoday.retry.RetryPolicy) SimpleRetryPolicy(cn.taketoday.retry.policy.SimpleRetryPolicy) TerminatedRetryException(cn.taketoday.retry.TerminatedRetryException) ExhaustedRetryException(cn.taketoday.retry.ExhaustedRetryException) BackOffInterruptedException(cn.taketoday.retry.backoff.BackOffInterruptedException) RetryException(cn.taketoday.retry.RetryException) TerminatedRetryException(cn.taketoday.retry.TerminatedRetryException)

Example 3 with BackOffContext

use of cn.taketoday.retry.backoff.BackOffContext in project today-framework by TAKETODAY.

the class RetryTemplateTests method testNoBackOffForRethrownException.

/**
 * {@link BackOffPolicy} should apply also for exceptions that are re-thrown.
 *
 * @throws Throwable on error
 */
@Test
public void testNoBackOffForRethrownException() throws Throwable {
    RetryTemplate tested = new RetryTemplate();
    tested.setRetryPolicy(new SimpleRetryPolicy(1));
    BackOffPolicy bop = createStrictMock(BackOffPolicy.class);
    @SuppressWarnings("serial") BackOffContext backOffContext = new BackOffContext() {
    };
    tested.setBackOffPolicy(bop);
    expect(bop.start(isA(RetryContext.class))).andReturn(backOffContext);
    replay(bop);
    try {
        tested.execute(new RetryCallback<Object, Exception>() {

            @Override
            public Object doWithRetry(RetryContext context) throws Exception {
                throw new Exception("maybe next time!");
            }
        }, null, new DefaultRetryState(tested) {

            @Override
            public boolean rollbackFor(Throwable exception) {
                return true;
            }
        });
        fail();
    } catch (Exception expected) {
        assertEquals("maybe next time!", expected.getMessage());
    }
    verify(bop);
}
Also used : BackOffPolicy(cn.taketoday.retry.backoff.BackOffPolicy) StatelessBackOffPolicy(cn.taketoday.retry.backoff.StatelessBackOffPolicy) BackOffContext(cn.taketoday.retry.backoff.BackOffContext) RetryContext(cn.taketoday.retry.RetryContext) SimpleRetryPolicy(cn.taketoday.retry.policy.SimpleRetryPolicy) TerminatedRetryException(cn.taketoday.retry.TerminatedRetryException) BackOffInterruptedException(cn.taketoday.retry.backoff.BackOffInterruptedException) Test(org.junit.Test)

Example 4 with BackOffContext

use of cn.taketoday.retry.backoff.BackOffContext in project today-infrastructure by TAKETODAY.

the class RetryTemplateTests method testNoBackOffForRethrownException.

/**
 * {@link BackOffPolicy} should apply also for exceptions that are re-thrown.
 *
 * @throws Throwable on error
 */
@Test
public void testNoBackOffForRethrownException() throws Throwable {
    RetryTemplate tested = new RetryTemplate();
    tested.setRetryPolicy(new SimpleRetryPolicy(1));
    BackOffPolicy bop = createStrictMock(BackOffPolicy.class);
    @SuppressWarnings("serial") BackOffContext backOffContext = new BackOffContext() {
    };
    tested.setBackOffPolicy(bop);
    expect(bop.start(isA(RetryContext.class))).andReturn(backOffContext);
    replay(bop);
    try {
        tested.execute(new RetryCallback<Object, Exception>() {

            @Override
            public Object doWithRetry(RetryContext context) throws Exception {
                throw new Exception("maybe next time!");
            }
        }, null, new DefaultRetryState(tested) {

            @Override
            public boolean rollbackFor(Throwable exception) {
                return true;
            }
        });
        fail();
    } catch (Exception expected) {
        assertEquals("maybe next time!", expected.getMessage());
    }
    verify(bop);
}
Also used : BackOffPolicy(cn.taketoday.retry.backoff.BackOffPolicy) StatelessBackOffPolicy(cn.taketoday.retry.backoff.StatelessBackOffPolicy) BackOffContext(cn.taketoday.retry.backoff.BackOffContext) RetryContext(cn.taketoday.retry.RetryContext) SimpleRetryPolicy(cn.taketoday.retry.policy.SimpleRetryPolicy) TerminatedRetryException(cn.taketoday.retry.TerminatedRetryException) BackOffInterruptedException(cn.taketoday.retry.backoff.BackOffInterruptedException) Test(org.junit.Test)

Aggregations

RetryContext (cn.taketoday.retry.RetryContext)4 TerminatedRetryException (cn.taketoday.retry.TerminatedRetryException)4 BackOffContext (cn.taketoday.retry.backoff.BackOffContext)4 BackOffInterruptedException (cn.taketoday.retry.backoff.BackOffInterruptedException)4 BackOffPolicy (cn.taketoday.retry.backoff.BackOffPolicy)4 SimpleRetryPolicy (cn.taketoday.retry.policy.SimpleRetryPolicy)4 ExhaustedRetryException (cn.taketoday.retry.ExhaustedRetryException)2 RetryException (cn.taketoday.retry.RetryException)2 RetryPolicy (cn.taketoday.retry.RetryPolicy)2 NoBackOffPolicy (cn.taketoday.retry.backoff.NoBackOffPolicy)2 StatelessBackOffPolicy (cn.taketoday.retry.backoff.StatelessBackOffPolicy)2 Test (org.junit.Test)2