org.apache.camel.model.OnExceptionDefinition Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.camel.model;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementRef;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import org.apache.camel.CamelContext;
import org.apache.camel.Expression;
import org.apache.camel.LoggingLevel;
import org.apache.camel.Predicate;
import org.apache.camel.Processor;
import org.apache.camel.Route;
import org.apache.camel.builder.ErrorHandlerBuilder;
import org.apache.camel.builder.ExpressionBuilder;
import org.apache.camel.processor.CatchProcessor;
import org.apache.camel.processor.FatalFallbackErrorHandler;
import org.apache.camel.processor.RedeliveryPolicy;
import org.apache.camel.spi.AsPredicate;
import org.apache.camel.spi.ClassResolver;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.RouteContext;
import org.apache.camel.util.CamelContextHelper;
import org.apache.camel.util.ExpressionToPredicateAdapter;
import org.apache.camel.util.ObjectHelper;
/**
* Route to be executed when an exception is thrown
*
* @version
*/
@Metadata(label = "error")
@XmlRootElement(name = "onException")
@XmlAccessorType(XmlAccessType.FIELD)
public class OnExceptionDefinition extends ProcessorDefinition {
@XmlElement(name = "exception", required = true)
private List exceptions = new ArrayList();
@XmlElement(name = "onWhen") @AsPredicate
private WhenDefinition onWhen;
@XmlElement(name = "retryWhile") @AsPredicate
private ExpressionSubElementDefinition retryWhile;
@XmlElement(name = "redeliveryPolicy")
private RedeliveryPolicyDefinition redeliveryPolicyType;
@XmlAttribute(name = "redeliveryPolicyRef")
private String redeliveryPolicyRef;
@XmlElement(name = "handled") @AsPredicate
private ExpressionSubElementDefinition handled;
@XmlElement(name = "continued") @AsPredicate
private ExpressionSubElementDefinition continued;
@XmlAttribute(name = "onRedeliveryRef")
private String onRedeliveryRef;
@XmlAttribute(name = "onExceptionOccurredRef")
private String onExceptionOccurredRef;
@XmlAttribute(name = "useOriginalMessage")
private Boolean useOriginalMessagePolicy;
@XmlElementRef
private List> outputs = new ArrayList>();
@XmlTransient
private List> exceptionClasses;
@XmlTransient
private Predicate handledPolicy;
@XmlTransient
private Predicate continuedPolicy;
@XmlTransient
private Predicate retryWhilePolicy;
@XmlTransient
private Processor onRedelivery;
@XmlTransient
private Processor onExceptionOccurred;
@XmlTransient
private Boolean routeScoped;
// TODO: in Camel 3.0 the OnExceptionDefinition should not contain state and ErrorHandler processors
@XmlTransient
private final Map errorHandlers = new HashMap();
@XmlTransient
private RedeliveryPolicy redeliveryPolicy;
public OnExceptionDefinition() {
}
public OnExceptionDefinition(List> exceptionClasses) {
this.exceptionClasses = exceptionClasses;
}
public OnExceptionDefinition(Class exceptionType) {
exceptionClasses = new ArrayList>();
exceptionClasses.add(exceptionType);
}
public void setRouteScoped(boolean routeScoped) {
this.routeScoped = routeScoped;
}
public boolean isRouteScoped() {
// is context scoped by default
return routeScoped != null ? routeScoped : false;
}
@Override
public String toString() {
return "OnException[" + description() + " -> " + getOutputs() + "]";
}
protected String description() {
return getExceptionClasses() + (onWhen != null ? " " + onWhen : "");
}
@Override
public String getLabel() {
return "onException[" + description() + "]";
}
@Override
public boolean isAbstract() {
return true;
}
@Override
public boolean isTopLevelOnly() {
return true;
}
/**
* Allows an exception handler to create a new redelivery policy for this exception type
*
* @param context the camel context
* @param parentPolicy the current redelivery policy, is newer null
* @return a newly created redelivery policy, or return the original policy if no customization is required
* for this exception handler.
*/
public RedeliveryPolicy createRedeliveryPolicy(CamelContext context, RedeliveryPolicy parentPolicy) {
if (redeliveryPolicy != null) {
return redeliveryPolicy;
} else if (redeliveryPolicyRef != null) {
return CamelContextHelper.mandatoryLookup(context, redeliveryPolicyRef, RedeliveryPolicy.class);
} else if (redeliveryPolicyType != null) {
return redeliveryPolicyType.createRedeliveryPolicy(context, parentPolicy);
} else if (!outputs.isEmpty() && parentPolicy.getMaximumRedeliveries() != 0) {
// if we have outputs, then do not inherit parent maximumRedeliveries
// as you would have to explicit configure maximumRedeliveries on this onException to use it
// this is the behavior Camel has always had
RedeliveryPolicy answer = parentPolicy.copy();
answer.setMaximumRedeliveries(0);
return answer;
} else {
return parentPolicy;
}
}
public void addRoutes(RouteContext routeContext, Collection routes) throws Exception {
// assign whether this was a route scoped onException or not
// we need to know this later when setting the parent, as only route scoped should have parent
// Note: this logic can possible be removed when the Camel routing engine decides at runtime
// to apply onException in a more dynamic fashion than current code base
// and therefore is in a better position to decide among context/route scoped OnException at runtime
if (routeScoped == null) {
routeScoped = super.getParent() != null;
}
setHandledFromExpressionType(routeContext);
setContinuedFromExpressionType(routeContext);
setRetryWhileFromExpressionType(routeContext);
setOnRedeliveryFromRedeliveryRef(routeContext);
setOnExceptionOccurredFromOnExceptionOccurredRef(routeContext);
// load exception classes
if (exceptions != null && !exceptions.isEmpty()) {
exceptionClasses = createExceptionClasses(routeContext.getCamelContext().getClassResolver());
}
// must validate configuration before creating processor
validateConfiguration();
if (useOriginalMessagePolicy != null && useOriginalMessagePolicy) {
// ensure allow original is turned on
routeContext.setAllowUseOriginalMessage(true);
}
// lets attach this on exception to the route error handler
Processor child = createOutputsProcessor(routeContext);
if (child != null) {
// wrap in our special safe fallback error handler if OnException have child output
Processor errorHandler = new FatalFallbackErrorHandler(child);
String id = routeContext.getRoute().getId();
errorHandlers.put(id, errorHandler);
}
// lookup the error handler builder
ErrorHandlerBuilder builder = (ErrorHandlerBuilder)routeContext.getRoute().getErrorHandlerBuilder();
// and add this as error handlers
builder.addErrorHandlers(routeContext, this);
}
@Override
public CatchProcessor createProcessor(RouteContext routeContext) throws Exception {
// load exception classes
if (exceptions != null && !exceptions.isEmpty()) {
exceptionClasses = createExceptionClasses(routeContext.getCamelContext().getClassResolver());
}
if (useOriginalMessagePolicy != null && useOriginalMessagePolicy) {
// ensure allow original is turned on
routeContext.setAllowUseOriginalMessage(true);
}
// must validate configuration before creating processor
validateConfiguration();
Processor childProcessor = this.createChildProcessor(routeContext, false);
Predicate when = null;
if (onWhen != null) {
when = onWhen.getExpression().createPredicate(routeContext);
}
Predicate handle = null;
if (handled != null) {
handle = handled.createPredicate(routeContext);
}
return new CatchProcessor(getExceptionClasses(), childProcessor, when, handle);
}
protected void validateConfiguration() {
if (isInheritErrorHandler() != null && isInheritErrorHandler()) {
throw new IllegalArgumentException(this + " cannot have the inheritErrorHandler option set to true");
}
List> exceptions = getExceptionClasses();
if (exceptions == null || exceptions.isEmpty()) {
throw new IllegalArgumentException("At least one exception must be configured on " + this);
}
// only one of handled or continued is allowed
if (getHandledPolicy() != null && getContinuedPolicy() != null) {
throw new IllegalArgumentException("Only one of handled or continued is allowed to be configured on: " + this);
}
// validate that at least some option is set as you cannot just have onException(Exception.class);
if (outputs == null || getOutputs().isEmpty()) {
// no outputs so there should be some sort of configuration
ObjectHelper.firstNotNull(
handledPolicy,
continuedPolicy,
retryWhilePolicy,
redeliveryPolicyType,
useOriginalMessagePolicy,
redeliveryPolicy,
onRedeliveryRef,
onRedelivery,
onExceptionOccurred)
.orElseThrow(() -> new IllegalArgumentException(this + " is not configured."));
}
}
// Fluent API
//-------------------------------------------------------------------------
@Override
public OnExceptionDefinition onException(Class exceptionType) {
getExceptionClasses().add(exceptionType);
return this;
}
/**
* Sets whether the exchange should be marked as handled or not.
*
* @param handled handled or not
* @return the builder
*/
public OnExceptionDefinition handled(boolean handled) {
Expression expression = ExpressionBuilder.constantExpression(Boolean.toString(handled));
return handled(expression);
}
/**
* Sets whether the exchange should be marked as handled or not.
*
* @param handled predicate that determines true or false
* @return the builder
*/
public OnExceptionDefinition handled(@AsPredicate Predicate handled) {
setHandledPolicy(handled);
return this;
}
/**
* Sets whether the exchange should be marked as handled or not.
*
* @param handled expression that determines true or false
* @return the builder
*/
public OnExceptionDefinition handled(@AsPredicate Expression handled) {
setHandledPolicy(ExpressionToPredicateAdapter.toPredicate(handled));
return this;
}
/**
* Sets whether the exchange should handle and continue routing from the point of failure.
*
* If this option is enabled then its considered handled as well.
*
* @param continued continued or not
* @return the builder
*/
public OnExceptionDefinition continued(boolean continued) {
Expression expression = ExpressionBuilder.constantExpression(Boolean.toString(continued));
return continued(expression);
}
/**
* Sets whether the exchange should be marked as handled or not.
*
* If this option is enabled then its considered handled as well.
*
* @param continued predicate that determines true or false
* @return the builder
*/
public OnExceptionDefinition continued(@AsPredicate Predicate continued) {
setContinuedPolicy(continued);
return this;
}
/**
* Sets whether the exchange should be marked as handled or not.
*
* If this option is enabled then its considered handled as well.
*
* @param continued expression that determines true or false
* @return the builder
*/
public OnExceptionDefinition continued(@AsPredicate Expression continued) {
setContinuedPolicy(ExpressionToPredicateAdapter.toPredicate(continued));
return this;
}
/**
* Sets an additional predicate that should be true before the onException is triggered.
*
* To be used for fine grained controlling whether a thrown exception should be intercepted
* by this exception type or not.
*
* @param predicate predicate that determines true or false
* @return the builder
*/
public OnExceptionDefinition onWhen(@AsPredicate Predicate predicate) {
setOnWhen(new WhenDefinition(predicate));
return this;
}
/**
* Sets the retry while predicate.
*
* Will continue retrying until predicate returns false.
*
* @param retryWhile predicate that determines when to stop retrying
* @return the builder
*/
public OnExceptionDefinition retryWhile(@AsPredicate Predicate retryWhile) {
setRetryWhilePolicy(retryWhile);
return this;
}
/**
* Sets the initial redelivery delay
*
* @param delay the initial redelivery delay
* @return the builder
* @deprecated will be removed in the near future. Instead use {@link #redeliveryDelay(String)}
*/
@Deprecated
public OnExceptionDefinition redeliverDelay(long delay) {
getOrCreateRedeliveryPolicy().redeliveryDelay(delay);
return this;
}
/**
* Sets the back off multiplier
*
* @param backOffMultiplier the back off multiplier
* @return the builder
*/
public OnExceptionDefinition backOffMultiplier(double backOffMultiplier) {
getOrCreateRedeliveryPolicy().useExponentialBackOff();
getOrCreateRedeliveryPolicy().backOffMultiplier(backOffMultiplier);
return this;
}
/**
* Sets the back off multiplier (supports property placeholders)
*
* @param backOffMultiplier the back off multiplier
* @return the builder
*/
public OnExceptionDefinition backOffMultiplier(String backOffMultiplier) {
getOrCreateRedeliveryPolicy().useExponentialBackOff();
getOrCreateRedeliveryPolicy().backOffMultiplier(backOffMultiplier);
return this;
}
/**
* Sets the collision avoidance factor
*
* @param collisionAvoidanceFactor the factor
* @return the builder
*/
public OnExceptionDefinition collisionAvoidanceFactor(double collisionAvoidanceFactor) {
getOrCreateRedeliveryPolicy().useCollisionAvoidance();
getOrCreateRedeliveryPolicy().collisionAvoidanceFactor(collisionAvoidanceFactor);
return this;
}
/**
* Sets the collision avoidance factor (supports property placeholders)
*
* @param collisionAvoidanceFactor the factor
* @return the builder
*/
public OnExceptionDefinition collisionAvoidanceFactor(String collisionAvoidanceFactor) {
getOrCreateRedeliveryPolicy().useCollisionAvoidance();
getOrCreateRedeliveryPolicy().collisionAvoidanceFactor(collisionAvoidanceFactor);
return this;
}
/**
* Sets the collision avoidance percentage
*
* @param collisionAvoidancePercent the percentage
* @return the builder
*/
public OnExceptionDefinition collisionAvoidancePercent(double collisionAvoidancePercent) {
getOrCreateRedeliveryPolicy().useCollisionAvoidance();
getOrCreateRedeliveryPolicy().collisionAvoidancePercent(collisionAvoidancePercent);
return this;
}
/**
* Sets the initial redelivery delay
*
* @param delay delay in millis
* @return the builder
*/
public OnExceptionDefinition redeliveryDelay(long delay) {
getOrCreateRedeliveryPolicy().redeliveryDelay(delay);
return this;
}
/**
* Sets the initial redelivery delay (supports property placeholders)
*
* @param delay delay in millis
* @return the builder
*/
public OnExceptionDefinition redeliveryDelay(String delay) {
getOrCreateRedeliveryPolicy().redeliveryDelay(delay);
return this;
}
/**
* Allow synchronous delayed redelivery.
*
* @see org.apache.camel.processor.RedeliveryPolicy#setAsyncDelayedRedelivery(boolean)
* @return the builder
*/
public OnExceptionDefinition asyncDelayedRedelivery() {
getOrCreateRedeliveryPolicy().asyncDelayedRedelivery();
return this;
}
/**
* Sets the logging level to use when retries has exhausted
*
* @param retriesExhaustedLogLevel the logging level
* @return the builder
*/
public OnExceptionDefinition retriesExhaustedLogLevel(LoggingLevel retriesExhaustedLogLevel) {
getOrCreateRedeliveryPolicy().retriesExhaustedLogLevel(retriesExhaustedLogLevel);
return this;
}
/**
* Sets the logging level to use for logging retry attempts
*
* @param retryAttemptedLogLevel the logging level
* @return the builder
*/
public OnExceptionDefinition retryAttemptedLogLevel(LoggingLevel retryAttemptedLogLevel) {
getOrCreateRedeliveryPolicy().retryAttemptedLogLevel(retryAttemptedLogLevel);
return this;
}
/**
* Sets whether to log stacktrace for failed messages.
*/
public OnExceptionDefinition logStackTrace(boolean logStackTrace) {
getOrCreateRedeliveryPolicy().logStackTrace(logStackTrace);
return this;
}
/**
* Sets whether to log stacktrace for failed messages (supports property placeholders)
*/
public OnExceptionDefinition logStackTrace(String logStackTrace) {
getOrCreateRedeliveryPolicy().logStackTrace(logStackTrace);
return this;
}
/**
* Sets whether to log stacktrace for failed redelivery attempts
*/
public OnExceptionDefinition logRetryStackTrace(boolean logRetryStackTrace) {
getOrCreateRedeliveryPolicy().logRetryStackTrace(logRetryStackTrace);
return this;
}
/**
* Sets whether to log stacktrace for failed redelivery attempts (supports property placeholders)
*/
public OnExceptionDefinition logRetryStackTrace(String logRetryStackTrace) {
getOrCreateRedeliveryPolicy().logRetryStackTrace(logRetryStackTrace);
return this;
}
/**
* Sets whether to log errors even if its handled
*/
public OnExceptionDefinition logHandled(boolean logHandled) {
getOrCreateRedeliveryPolicy().logHandled(logHandled);
return this;
}
/**
* Sets whether to log errors even if its handled (supports property placeholders)
*/
public OnExceptionDefinition logHandled(String logHandled) {
getOrCreateRedeliveryPolicy().logHandled(logHandled);
return this;
}
/**
* Sets whether new exceptions should be logged or not (supports property placeholders).
* Can be used to include or reduce verbose.
*
* A new exception is an exception that was thrown while handling a previous exception.
*/
public OnExceptionDefinition logNewException(boolean logNewException) {
getOrCreateRedeliveryPolicy().logNewException(logNewException);
return this;
}
/**
* Sets whether new exceptions should be logged or not (supports property placeholders).
* Can be used to include or reduce verbose.
*
* A new exception is an exception that was thrown while handling a previous exception.
*/
public OnExceptionDefinition logNewException(String logNewException) {
getOrCreateRedeliveryPolicy().logNewException(logNewException);
return this;
}
/**
* Sets whether to log errors even if its continued
*/
public OnExceptionDefinition logContinued(boolean logContinued) {
getOrCreateRedeliveryPolicy().logContinued(logContinued);
return this;
}
/**
* Sets whether to log errors even if its continued (supports property placeholders)
*/
public OnExceptionDefinition logContinued(String logContinued) {
getOrCreateRedeliveryPolicy().logContinued(logContinued);
return this;
}
/**
* Sets whether to log retry attempts
*/
public OnExceptionDefinition logRetryAttempted(boolean logRetryAttempted) {
getOrCreateRedeliveryPolicy().logRetryAttempted(logRetryAttempted);
return this;
}
/**
* Sets whether to log retry attempts (supports property placeholders)
*/
public OnExceptionDefinition logRetryAttempted(String logRetryAttempted) {
getOrCreateRedeliveryPolicy().logRetryAttempted(logRetryAttempted);
return this;
}
/**
* Sets whether to log exhausted exceptions
*/
public OnExceptionDefinition logExhausted(boolean logExhausted) {
getOrCreateRedeliveryPolicy().logExhausted(logExhausted);
return this;
}
/**
* Sets whether to log exhausted exceptions (supports property placeholders)
*/
public OnExceptionDefinition logExhausted(String logExhausted) {
getOrCreateRedeliveryPolicy().logExhausted(logExhausted);
return this;
}
/**
* Sets whether to log exhausted exceptions with message history
*/
public OnExceptionDefinition logExhaustedMessageHistory(boolean logExhaustedMessageHistory) {
getOrCreateRedeliveryPolicy().logExhaustedMessageHistory(logExhaustedMessageHistory);
return this;
}
/**
* Sets whether to log exhausted exceptions with message history
*/
public OnExceptionDefinition logExhaustedMessageHistory(String logExhaustedMessageHistory) {
getOrCreateRedeliveryPolicy().logExhaustedMessageHistory(logExhaustedMessageHistory);
return this;
}
/**
* Sets whether to log exhausted message body with message history.
* Requires logExhaustedMessageHistory to be enabled.
*/
public OnExceptionDefinition logExhaustedMessageBody(boolean logExhaustedMessageBody) {
getOrCreateRedeliveryPolicy().logExhaustedMessageBody(logExhaustedMessageBody);
return this;
}
/**
* Sets whether to log exhausted message body with message history.
* Requires logExhaustedMessageHistory to be enabled.
*/
public OnExceptionDefinition logExhaustedMessageBody(String logExhaustedMessageBody) {
getOrCreateRedeliveryPolicy().logExhaustedMessageBody(logExhaustedMessageBody);
return this;
}
/**
* Sets the maximum redeliveries
*
* - 5 = default value
* - 0 = no redeliveries
* - -1 = redeliver forever
*
*
* @param maximumRedeliveries the value
* @return the builder
*/
public OnExceptionDefinition maximumRedeliveries(int maximumRedeliveries) {
getOrCreateRedeliveryPolicy().maximumRedeliveries(maximumRedeliveries);
return this;
}
/**
* Sets the maximum redeliveries (supports property placeholders)
*
* - 5 = default value
* - 0 = no redeliveries
* - -1 = redeliver forever
*
*
* @param maximumRedeliveries the value
* @return the builder
*/
public OnExceptionDefinition maximumRedeliveries(String maximumRedeliveries) {
getOrCreateRedeliveryPolicy().maximumRedeliveries(maximumRedeliveries);
return this;
}
/**
* Turn on collision avoidance.
*
* @return the builder
*/
public OnExceptionDefinition useCollisionAvoidance() {
getOrCreateRedeliveryPolicy().useCollisionAvoidance();
return this;
}
/**
* Turn on exponential back off
*
* @return the builder
*/
public OnExceptionDefinition useExponentialBackOff() {
getOrCreateRedeliveryPolicy().useExponentialBackOff();
return this;
}
/**
* Sets the maximum delay between redelivery
*
* @param maximumRedeliveryDelay the delay in millis
* @return the builder
*/
public OnExceptionDefinition maximumRedeliveryDelay(long maximumRedeliveryDelay) {
getOrCreateRedeliveryPolicy().maximumRedeliveryDelay(maximumRedeliveryDelay);
return this;
}
/**
* Sets the maximum delay between redelivery (supports property placeholders)
*
* @param maximumRedeliveryDelay the delay in millis
* @return the builder
*/
public OnExceptionDefinition maximumRedeliveryDelay(String maximumRedeliveryDelay) {
getOrCreateRedeliveryPolicy().maximumRedeliveryDelay(maximumRedeliveryDelay);
return this;
}
/**
* Set the {@link RedeliveryPolicy} to be used.
*
* @param redeliveryPolicy the redelivery policy
* @return the builder
*/
public OnExceptionDefinition redeliveryPolicy(RedeliveryPolicy redeliveryPolicy) {
this.redeliveryPolicy = redeliveryPolicy;
return this;
}
/**
* Sets a reference to a {@link RedeliveryPolicy} to lookup in the {@link org.apache.camel.spi.Registry} to be used.
*
* @param redeliveryPolicyRef reference to use for lookup
* @return the builder
*/
public OnExceptionDefinition redeliveryPolicyRef(String redeliveryPolicyRef) {
setRedeliveryPolicyRef(redeliveryPolicyRef);
return this;
}
/**
* Sets the delay pattern with delay intervals.
*
* @param delayPattern the delay pattern
* @return the builder
*/
public OnExceptionDefinition delayPattern(String delayPattern) {
getOrCreateRedeliveryPolicy().setDelayPattern(delayPattern);
return this;
}
/**
* @deprecated this method will be removed in Camel 3.0, please use {@link #useOriginalMessage()}
* @see #useOriginalMessage()
*/
@Deprecated
public OnExceptionDefinition useOriginalBody() {
setUseOriginalMessagePolicy(Boolean.TRUE);
return this;
}
/**
* Will use the original input message when an {@link org.apache.camel.Exchange} is moved to the dead letter queue.
*
* Notice: this only applies when all redeliveries attempt have failed and the {@link org.apache.camel.Exchange} is doomed for failure.
*
* Instead of using the current in-progress {@link org.apache.camel.Exchange} IN body we use the original IN body instead. This allows
* you to store the original input in the dead letter queue instead of the in-progress snapshot of the IN body.
* For instance if you route transform the IN body during routing and then failed. With the original exchange
* store in the dead letter queue it might be easier to manually re submit the {@link org.apache.camel.Exchange} again as the IN body
* is the same as when Camel received it. So you should be able to send the {@link org.apache.camel.Exchange} to the same input.
*
* By default this feature is off.
*
* @return the builder
*/
public OnExceptionDefinition useOriginalMessage() {
setUseOriginalMessagePolicy(Boolean.TRUE);
return this;
}
/**
* Sets a processor that should be processed before a redelivery attempt.
*
* Can be used to change the {@link org.apache.camel.Exchange} before its being redelivered.
*/
public OnExceptionDefinition onRedelivery(Processor processor) {
setOnRedelivery(processor);
return this;
}
/**
* Sets a reference to a processor that should be processed before a redelivery attempt.
*
* Can be used to change the {@link org.apache.camel.Exchange} before its being redelivered.
*
* @param ref reference to the processor
*/
public OnExceptionDefinition onRedeliveryRef(String ref) {
setOnRedeliveryRef(ref);
return this;
}
/**
* Sets a processor that should be processed just after an exception occurred.
* Can be used to perform custom logging about the occurred exception at the exact time it happened.
*
* Important: Any exception thrown from this processor will be ignored.
*/
public OnExceptionDefinition onExceptionOccurred(Processor processor) {
setOnExceptionOccurred(processor);
return this;
}
/**
* Sets a reference to a processor that should be processed just after an exception occurred.
* Can be used to perform custom logging about the occurred exception at the exact time it happened.
*
* Important: Any exception thrown from this processor will be ignored.
*
* @param ref reference to the processor
*/
public OnExceptionDefinition onExceptionOccurredRef(String ref) {
setOnExceptionOccurredRef(ref);
return this;
}
// Properties
//-------------------------------------------------------------------------
@Override
public List> getOutputs() {
return outputs;
}
public void setOutputs(List> outputs) {
this.outputs = outputs;
}
public boolean isOutputSupported() {
return true;
}
public List> getExceptionClasses() {
return exceptionClasses;
}
public void setExceptionClasses(List> exceptionClasses) {
this.exceptionClasses = exceptionClasses;
}
public List getExceptions() {
return exceptions;
}
/**
* A set of exceptions to react upon.
*/
public void setExceptions(List exceptions) {
this.exceptions = exceptions;
}
public Processor getErrorHandler(String routeId) {
return errorHandlers.get(routeId);
}
public Collection getErrorHandlers() {
return errorHandlers.values();
}
public RedeliveryPolicyDefinition getRedeliveryPolicy() {
return redeliveryPolicyType;
}
public void setRedeliveryPolicy(RedeliveryPolicyDefinition redeliveryPolicy) {
this.redeliveryPolicyType = redeliveryPolicy;
}
public RedeliveryPolicyDefinition getRedeliveryPolicyType() {
return redeliveryPolicyType;
}
public void setRedeliveryPolicyType(RedeliveryPolicyDefinition redeliveryPolicyType) {
this.redeliveryPolicyType = redeliveryPolicyType;
}
public String getRedeliveryPolicyRef() {
return redeliveryPolicyRef;
}
public void setRedeliveryPolicyRef(String redeliveryPolicyRef) {
this.redeliveryPolicyRef = redeliveryPolicyRef;
}
public Predicate getHandledPolicy() {
return handledPolicy;
}
public void setHandled(ExpressionSubElementDefinition handled) {
this.handled = handled;
}
public ExpressionSubElementDefinition getContinued() {
return continued;
}
public void setContinued(ExpressionSubElementDefinition continued) {
this.continued = continued;
}
public ExpressionSubElementDefinition getHandled() {
return handled;
}
public void setHandledPolicy(Predicate handledPolicy) {
this.handledPolicy = handledPolicy;
}
public Predicate getContinuedPolicy() {
return continuedPolicy;
}
public void setContinuedPolicy(Predicate continuedPolicy) {
this.continuedPolicy = continuedPolicy;
}
public WhenDefinition getOnWhen() {
return onWhen;
}
public void setOnWhen(WhenDefinition onWhen) {
this.onWhen = onWhen;
}
public ExpressionSubElementDefinition getRetryWhile() {
return retryWhile;
}
public void setRetryWhile(ExpressionSubElementDefinition retryWhile) {
this.retryWhile = retryWhile;
}
public Predicate getRetryWhilePolicy() {
return retryWhilePolicy;
}
public void setRetryWhilePolicy(Predicate retryWhilePolicy) {
this.retryWhilePolicy = retryWhilePolicy;
}
public Processor getOnRedelivery() {
return onRedelivery;
}
public void setOnRedelivery(Processor onRedelivery) {
this.onRedelivery = onRedelivery;
}
public String getOnRedeliveryRef() {
return onRedeliveryRef;
}
public void setOnRedeliveryRef(String onRedeliveryRef) {
this.onRedeliveryRef = onRedeliveryRef;
}
public Processor getOnExceptionOccurred() {
return onExceptionOccurred;
}
public void setOnExceptionOccurred(Processor onExceptionOccurred) {
this.onExceptionOccurred = onExceptionOccurred;
}
public String getOnExceptionOccurredRef() {
return onExceptionOccurredRef;
}
public void setOnExceptionOccurredRef(String onExceptionOccurredRef) {
this.onExceptionOccurredRef = onExceptionOccurredRef;
}
public Boolean getUseOriginalMessagePolicy() {
return useOriginalMessagePolicy;
}
public void setUseOriginalMessagePolicy(Boolean useOriginalMessagePolicy) {
this.useOriginalMessagePolicy = useOriginalMessagePolicy;
}
// Implementation methods
//-------------------------------------------------------------------------
protected boolean isAsyncDelayedRedelivery(CamelContext context) {
if (getRedeliveryPolicy() != null) {
return getRedeliveryPolicy().isAsyncDelayedRedelivery(context);
}
return false;
}
protected RedeliveryPolicyDefinition getOrCreateRedeliveryPolicy() {
if (redeliveryPolicyType == null) {
redeliveryPolicyType = new RedeliveryPolicyDefinition();
}
return redeliveryPolicyType;
}
protected List> createExceptionClasses(ClassResolver resolver) throws ClassNotFoundException {
List list = getExceptions();
List> answer = new ArrayList>(list.size());
for (String name : list) {
Class type = resolver.resolveMandatoryClass(name, Throwable.class);
answer.add(type);
}
return answer;
}
private void setHandledFromExpressionType(RouteContext routeContext) {
if (getHandled() != null && handledPolicy == null && routeContext != null) {
handled(getHandled().createPredicate(routeContext));
}
}
private void setContinuedFromExpressionType(RouteContext routeContext) {
if (getContinued() != null && continuedPolicy == null && routeContext != null) {
continued(getContinued().createPredicate(routeContext));
}
}
private void setRetryWhileFromExpressionType(RouteContext routeContext) {
if (getRetryWhile() != null && retryWhilePolicy == null && routeContext != null) {
retryWhile(getRetryWhile().createPredicate(routeContext));
}
}
private void setOnRedeliveryFromRedeliveryRef(RouteContext routeContext) {
// lookup onRedelivery if ref is provided
if (ObjectHelper.isNotEmpty(onRedeliveryRef)) {
// if ref is provided then use mandatory lookup to fail if not found
Processor onRedelivery = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), onRedeliveryRef, Processor.class);
setOnRedelivery(onRedelivery);
}
}
private void setOnExceptionOccurredFromOnExceptionOccurredRef(RouteContext routeContext) {
// lookup onRedelivery if ref is provided
if (ObjectHelper.isNotEmpty(onExceptionOccurredRef)) {
// if ref is provided then use mandatory lookup to fail if not found
Processor onExceptionOccurred = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), onExceptionOccurredRef, Processor.class);
setOnExceptionOccurred(onExceptionOccurred);
}
}
}