/*
* Copyright 2002-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.handler.advice;
import org.springframework.core.AttributeAccessor;
import org.springframework.integration.support.DefaultErrorMessageStrategy;
import org.springframework.integration.support.ErrorMessagePublisher;
import org.springframework.integration.support.ErrorMessageStrategy;
import org.springframework.integration.support.ErrorMessageUtils;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.MessagingException;
import org.springframework.retry.RecoveryCallback;
import org.springframework.retry.RetryContext;
/**
* A {@link RecoveryCallback} that sends the final throwable as an
* {@link org.springframework.messaging.support.ErrorMessage} after
* retry exhaustion.
*
* @author Gary Russell
* @author Artem Bilan
*
* @since 2.2
*
*/
public class ErrorMessageSendingRecoverer extends ErrorMessagePublisher implements RecoveryCallback<Object> {
/**
* Construct instance with the default {@code errorChannel}
* to publish recovery error message.
* @since 4.3.10
*/
public ErrorMessageSendingRecoverer() {
this(null);
}
/**
* Construct instance based on the provided message channel.
* The {@link DefaultErrorMessageStrategy} is used for building error message to publish.
* @param channel the message channel to publish error messages on recovery action.
*/
public ErrorMessageSendingRecoverer(MessageChannel channel) {
this(channel, new DefaultErrorMessageStrategy());
}
/**
* Construct instance based on the provided message channel and {@link ErrorMessageStrategy}.
* @param channel the message channel to publish error messages on recovery action.
* @param errorMessageStrategy the {@link ErrorMessageStrategy}
* to build error message for publishing.
* @since 4.3.10
*/
public ErrorMessageSendingRecoverer(MessageChannel channel, ErrorMessageStrategy errorMessageStrategy) {
setChannel(channel);
setErrorMessageStrategy(errorMessageStrategy);
}
@Override
public Object recover(RetryContext context) throws Exception {
publish(context.getLastThrowable(), context);
return null;
}
@Override
protected Throwable payloadWhenNull(AttributeAccessor context) {
return new RetryExceptionNotAvailableException(
(Message<?>) context.getAttribute(ErrorMessageUtils.FAILED_MESSAGE_CONTEXT_KEY),
"No retry exception available; " +
"this can occur, for example, if the RetryPolicy allowed zero attempts " +
"to execute the handler; " +
"RetryContext: " + context.toString());
}
public static class RetryExceptionNotAvailableException extends MessagingException {
private static final long serialVersionUID = 1L;
public RetryExceptionNotAvailableException(Message<?> message, String description) {
super(message, description);
}
}
}