io.bitsensor.plugins.shaded.org.springframework.amqp.rabbit.listener.ConditionalRejectingErrorHandler Maven / Gradle / Ivy
/*
* Copyright 2014-2016 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 io.bitsensor.plugins.shaded.io.bitsensor.plugins.shaded.org.springframework.amqp.rabbit.listener;
import io.bitsensor.plugins.shaded.org.apache.commons.logging.Log;
import io.bitsensor.plugins.shaded.org.apache.commons.logging.LogFactory;
import io.bitsensor.plugins.shaded.io.bitsensor.plugins.shaded.org.springframework.amqp.AmqpRejectAndDontRequeueException;
import io.bitsensor.plugins.shaded.io.bitsensor.plugins.shaded.org.springframework.amqp.rabbit.listener.exception.ListenerExecutionFailedException;
import io.bitsensor.plugins.shaded.io.bitsensor.plugins.shaded.org.springframework.amqp.support.converter.MessageConversionException;
import io.bitsensor.plugins.shaded.org.springframework.messaging.handler.annotation.support.MethodArgumentNotValidException;
import io.bitsensor.plugins.shaded.org.springframework.messaging.handler.annotation.support.MethodArgumentTypeMismatchException;
import io.bitsensor.plugins.shaded.org.springframework.util.ErrorHandler;
/**
* {@link ErrorHandler} that conditionally wraps the Exception in an
* {@link AmqpRejectAndDontRequeueException} if the configured rejection
* strategy determines that the message is fatal and should not be requeued.
* Such messages will be discarded or sent to a Dead Letter Exchange, depending
* on broker configuration.
*
* The default strategy will do this if the exception is a
* {@link ListenerExecutionFailedException} with a cause of {@link MessageConversionException},
* {@link io.bitsensor.plugins.shaded.org.springframework.messaging.converter.MessageConversionException},
* {@link MethodArgumentNotValidException}, {@link MethodArgumentTypeMismatchException},
* {@link NoSuchMethodException} or {@link ClassCastException}.
*
* The exception will not be wrapped if the {@code cause} chain already contains an
* {@link AmqpRejectAndDontRequeueException}.
*
* @author Gary Russell
* @since 1.3.2
*
*/
public class ConditionalRejectingErrorHandler implements ErrorHandler {
protected final Log logger = LogFactory.getLog(getClass()); // NOSONAR
private final FatalExceptionStrategy exceptionStrategy;
/**
* Create a handler with the {@link ConditionalRejectingErrorHandler.DefaultExceptionStrategy}.
*/
public ConditionalRejectingErrorHandler() {
this.exceptionStrategy = new DefaultExceptionStrategy();
}
/**
* Create a handler with the supplied {@link FatalExceptionStrategy} implementation.
* @param exceptionStrategy The strategy implementation.
*/
public ConditionalRejectingErrorHandler(FatalExceptionStrategy exceptionStrategy) {
this.exceptionStrategy = exceptionStrategy;
}
@Override
public void handleError(Throwable t) {
if (this.logger.isWarnEnabled()) {
this.logger.warn("Execution of Rabbit message listener failed.", t);
}
if (!this.causeChainContainsARADRE(t) && this.exceptionStrategy.isFatal(t)) {
throw new AmqpRejectAndDontRequeueException("Error Handler converted exception to fatal", t);
}
}
/**
* @return true if the cause chain already contains an
* {@link AmqpRejectAndDontRequeueException}.
*/
private boolean causeChainContainsARADRE(Throwable t) {
Throwable cause = t.getCause();
while (cause != null) {
if (cause instanceof AmqpRejectAndDontRequeueException) {
return true;
}
cause = cause.getCause();
}
return false;
}
/**
* Default implementation of {@link FatalExceptionStrategy}.
* @since 1.6.3
*/
public static class DefaultExceptionStrategy implements FatalExceptionStrategy {
protected final Log logger = LogFactory.getLog(getClass()); // NOSONAR
@Override
public boolean isFatal(Throwable t) {
if (t instanceof ListenerExecutionFailedException
&& isCauseFatal(t.getCause())) {
if (this.logger.isWarnEnabled()) {
this.logger.warn(
"Fatal message conversion error; message rejected; "
+ "it will be dropped or routed to a dead letter exchange, if so configured: "
+ ((ListenerExecutionFailedException) t).getFailedMessage());
}
return true;
}
return false;
}
private boolean isCauseFatal(Throwable cause) {
return cause instanceof MessageConversionException
|| cause instanceof io.bitsensor.plugins.shaded.org.springframework.messaging.converter.MessageConversionException
|| cause instanceof MethodArgumentNotValidException
|| cause instanceof MethodArgumentTypeMismatchException
|| cause instanceof NoSuchMethodException
|| cause instanceof ClassCastException
|| isUserCauseFatal(cause);
}
/**
* Subclasses can override this to add custom exceptions.
* @param cause the cause
* @return true if the cause is fatal.
*/
protected boolean isUserCauseFatal(Throwable cause) {
return false;
}
}
}