Fuse 6 is no longer supported
As of February 2025, Red Hat Fuse 6 is no longer supported. If you are using Fuse 6, please upgrade to Red Hat build of Apache Camel.이 콘텐츠는 선택한 언어로 제공되지 않습니다.
2.3. Exception Handling
Abstract
Apache Camel provides several different mechanisms, which let you handle exceptions at different levels of granularity: you can handle exceptions within a route using
doTry
, doCatch
, and doFinally
; or you can specify what action to take for each exception type and apply this rule to all routes in a RouteBuilder
using onException
; or you can specify what action to take for all exception types and apply this rule to all routes in a RouteBuilder
using errorHandler
.
For more details about exception handling, see Section 6.3, “Dead Letter Channel”.
2.3.1. onException Clause 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Overview 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The
onException
clause is a powerful mechanism for trapping exceptions that occur in one or more routes: it is type-specific, enabling you to define distinct actions to handle different exception types; it allows you to define actions using essentially the same (actually, slightly extended) syntax as a route, giving you considerable flexibility in the way you handle exceptions; and it is based on a trapping model, which enables a single onException
clause to deal with exceptions occurring at any node in any route.
Trapping exceptions using onException 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The
onException
clause is a mechanism for trapping, rather than catching exceptions. That is, once you define an onException
clause, it traps exceptions that occur at any point in a route. This contrasts with the Java try/catch mechanism, where an exception is caught, only if a particular code fragment is explicitly enclosed in a try block.
What really happens when you define an
onException
clause is that the Apache Camel runtime implicitly encloses each route node in a try block. This is why the onException
clause is able to trap exceptions at any point in the route. But this wrapping is done for you automatically; it is not visible in the route definitions.
Java DSL example 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
In the following Java DSL example, the
onException
clause applies to all of the routes defined in the RouteBuilder
class. If a ValidationException
exception occurs while processing either of the routes (from("seda:inputA")
or from("seda:inputB")
), the onException
clause traps the exception and redirects the current exchange to the validationFailed
JMS queue (which serves as a deadletter queue).
XML DSL example 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The preceding example can also be expressed in the XML DSL, using the
onException
element to define the exception clause, as follows:
Trapping multiple exceptions 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
You can define multiple
onException
clauses to trap exceptions in a RouteBuilder
scope. This enables you to take different actions in response to different exceptions. For example, the following series of onException
clauses defined in the Java DSL define different deadletter destinations for ValidationException
, ValidationException
, and Exception
:
onException(ValidationException.class).to("activemq:validationFailed"); onException(java.io.IOException.class).to("activemq:ioExceptions"); onException(Exception.class).to("activemq:exceptions");
onException(ValidationException.class).to("activemq:validationFailed");
onException(java.io.IOException.class).to("activemq:ioExceptions");
onException(Exception.class).to("activemq:exceptions");
You can define the same series of
onException
clauses in the XML DSL as follows:
You can also group multiple exceptions together to be trapped by the same
onException
clause. In the Java DSL, you can group multiple exceptions as follows:
onException(ValidationException.class, BuesinessException.class) .to("activemq:validationFailed");
onException(ValidationException.class, BuesinessException.class)
.to("activemq:validationFailed");
In the XML DSL, you can group multiple exceptions together by defining more than one
exception
element inside the onException
element, as follows:
<onException> <exception>com.mycompany.ValidationException</exception> <exception>com.mycompany.BuesinessException</exception> <to uri="activemq:validationFailed"/> </onException>
<onException>
<exception>com.mycompany.ValidationException</exception>
<exception>com.mycompany.BuesinessException</exception>
<to uri="activemq:validationFailed"/>
</onException>
When trapping multiple exceptions, the order of the
onException
clauses is significant. Apache Camel initially attempts to match the thrown exception against the first clause. If the first clause fails to match, the next onException
clause is tried, and so on until a match is found. Each matching attempt is governed by the following algorithm:
- If the thrown exception is a chained exception (that is, where an exception has been caught and rethrown as a different exception), the most nested exception type serves initially as the basis for matching. This exception is tested as follows:
- If the exception-to-test has exactly the type specified in the
onException
clause (tested usinginstanceof
), a match is triggered. - If the exception-to-test is a sub-type of the type specified in the
onException
clause, a match is triggered.
- If the most nested exception fails to yield a match, the next exception in the chain (the wrapping exception) is tested instead. The testing continues up the chain until either a match is triggered or the chain is exhausted.
Deadletter channel 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The basic examples of
onException
usage have so far all exploited the deadletter channel pattern. That is, when an onException
clause traps an exception, the current exchange is routed to a special destination (the deadletter channel). The deadletter channel serves as a holding area for failed messages that have not been processed. An administrator can inspect the messages at a later time and decide what action needs to be taken.
For more details about the deadletter channel pattern, see Section 6.3, “Dead Letter Channel”.
Use original message 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
By the time an exception is raised in the middle of a route, the message in the exchange could have been modified considerably (and might not even by readable by a human). Often, it is easier for an administrator to decide what corrective actions to take, if the messages visible in the deadletter queue are the original messages, as received at the start of the route.
In the Java DSL, you can replace the message in the exchange by the original message, using the
useOriginalMessage()
DSL command, as follows:
onException(ValidationException.class) .useOriginalMessage() .to("activemq:validationFailed");
onException(ValidationException.class)
.useOriginalMessage()
.to("activemq:validationFailed");
In the XML DSL, you can retrieve the original message by setting the
useOriginalMessage
attribute on the onException
element, as follows:
<onException useOriginalMessage="true"> <exception>com.mycompany.ValidationException</exception> <to uri="activemq:validationFailed"/> </onException>
<onException useOriginalMessage="true">
<exception>com.mycompany.ValidationException</exception>
<to uri="activemq:validationFailed"/>
</onException>
Note
By default, Camel makes a copy of the original message at the start of the route, which ensures that the original message is available when you call
useOriginalMessage()
. But if the setAllowUseOriginalMessage()
option is set to false
on the Camel context, the original message will not be accessible and you cannot call useOriginalMessage()
(for example, you might want to choose this behaviour to optimize performance when processing large messages).
Redelivery policy 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Instead of interrupting the processing of a message and giving up as soon as an exception is raised, Apache Camel gives you the option of attempting to redeliver the message at the point where the exception occurred. In networked systems, where timeouts can occur and temporary faults arise, it is often possible for failed messages to be processed successfully, if they are redelivered shortly after the original exception was raised.
The Apache Camel redelivery supports various strategies for redelivering messages after an exception occurs. Some of the most important options for configuring redelivery are as follows:
-
maximumRedeliveries()
- Specifies the maximum number of times redelivery can be attempted (default is
0
). A negative value means redelivery is always attempted (equivalent to an infinite value). -
retryWhile()
- Specifies a predicate (of
Predicate
type), which determines whether Apache Camel ought to continue redelivering. If the predicate evaluates totrue
on the current exchange, redelivery is attempted; otherwise, redelivery is stopped and no further redelivery attempts are made.This option takes precedence over themaximumRedeliveries()
option.
In the Java DSL, redelivery policy options are specified using DSL commands in the
onException
clause. For example, you can specify a maximum of six redeliveries, after which the exchange is sent to the validationFailed
deadletter queue, as follows:
onException(ValidationException.class) .maximumRedeliveries(6) .retryAttemptedLogLevel(org.apache.camel.LogginLevel.WARN) .to("activemq:validationFailed");
onException(ValidationException.class)
.maximumRedeliveries(6)
.retryAttemptedLogLevel(org.apache.camel.LogginLevel.WARN)
.to("activemq:validationFailed");
In the XML DSL, redelivery policy options are specified by setting attributes on the
redeliveryPolicy
element. For example, the preceding route can be expressed in XML DSL as follows:
<onException useOriginalMessage="true"> <exception>com.mycompany.ValidationException</exception> <redeliveryPolicy maximumRedeliveries="6"/> <to uri="activemq:validationFailed"/> </onException>
<onException useOriginalMessage="true">
<exception>com.mycompany.ValidationException</exception>
<redeliveryPolicy maximumRedeliveries="6"/>
<to uri="activemq:validationFailed"/>
</onException>
The latter part of the route—after the redelivery options are set—is not processed until after the last redelivery attempt has failed. For detailed descriptions of all the redelivery options, see Section 6.3, “Dead Letter Channel”.
Alternatively, you can specify redelivery policy options in a
redeliveryPolicyProfile
instance. You can then reference the redeliveryPolicyProfile
instance using the onException
element's redeliverPolicyRef
attribute. For example, the preceding route can be expressed as follows:
Note
The approach using
redeliveryPolicyProfile
is useful, if you want to re-use the same redelivery policy in multiple onException
clauses.
Conditional trapping 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Exception trapping with
onException
can be made conditional by specifying the onWhen
option. If you specify the onWhen
option in an onException
clause, a match is triggered only when the thrown exception matches the clause and the onWhen
predicate evaluates to true
on the current exchange.
For example, in the following Java DSL fragment,the first
onException
clause triggers, only if the thrown exception matches MyUserException
and the user
header is non-null in the current exchange:
The preceding
onException
clauses can be expressed in the XML DSL as follows:
Handling exceptions 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
By default, when an exception is raised in the middle of a route, processing of the current exchange is interrupted and the thrown exception is propagated back to the consumer endpoint at the start of the route. When an
onException
clause is triggered, the behavior is essentially the same, except that the onException
clause performs some processing before the thrown exception is propagated back.
But this default behavior is not the only way to handle an exception. The
onException
provides various options to modify the exception handling behavior, as follows:
- the section called “Suppressing exception rethrow”—you have the option of suppressing the rethrown exception after the
onException
clause has completed. In other words, in this case the exception does not propagate back to the consumer endpoint at the start of the route. - the section called “Continuing processing”—you have the option of resuming normal processing of the exchange from the point where the exception originally occurred. Implicitly, this approach also suppresses the rethrown exception.
- the section called “Sending a response”—in the special case where the consumer endpoint at the start of the route expects a reply (that is, having an InOut MEP), you might prefer to construct a custom fault reply message, rather than propagating the exception back to the consumer endpoint.
Suppressing exception rethrow 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
To prevent the current exception from being rethrown and propagated back to the consumer endpoint, you can set the
handled()
option to true
in the Java DSL, as follows:
onException(ValidationException.class) .handled(true) .to("activemq:validationFailed");
onException(ValidationException.class)
.handled(true)
.to("activemq:validationFailed");
In the Java DSL, the argument to the
handled()
option can be of boolean type, of Predicate
type, or of Expression
type (where any non-boolean expression is interpreted as true
, if it evaluates to a non-null value).
The same route can be configured to suppress the rethrown exception in the XML DSL, using the
handled
element, as follows:
Continuing processing 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
To continue processing the current message from the point in the route where the exception was originally thrown, you can set the
continued
option to true
in the Java DSL, as follows:
onException(ValidationException.class) .continued(true);
onException(ValidationException.class)
.continued(true);
In the Java DSL, the argument to the
continued()
option can be of boolean type, of Predicate
type, or of Expression
type (where any non-boolean expression is interpreted as true
, if it evaluates to a non-null value).
The same route can be configured in the XML DSL, using the
continued
element, as follows:
Sending a response 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
When the consumer endpoint that starts a route expects a reply, you might prefer to construct a custom fault reply message, instead of simply letting the thrown exception propagate back to the consumer. There are two essential steps you need to follow in this case: suppress the rethrown exception using the
handled
option; and populate the exchange's Out message slot with a custom fault message.
For example, the following Java DSL fragment shows how to send a reply message containing the text string,
Sorry
, whenever the MyFunctionalException
exception occurs:
// we catch MyFunctionalException and want to mark it as handled (= no failure returned to client) // but we want to return a fixed text response, so we transform OUT body as Sorry. onException(MyFunctionalException.class) .handled(true) .transform().constant("Sorry");
// we catch MyFunctionalException and want to mark it as handled (= no failure returned to client)
// but we want to return a fixed text response, so we transform OUT body as Sorry.
onException(MyFunctionalException.class)
.handled(true)
.transform().constant("Sorry");
If you are sending a fault response to the client, you will often want to incorporate the text of the exception message in the response. You can access the text of the current exception message using the
exceptionMessage()
builder method. For example, you can send a reply containing just the text of the exception message whenever the MyFunctionalException
exception occurs, as follows:
// we catch MyFunctionalException and want to mark it as handled (= no failure returned to client) // but we want to return a fixed text response, so we transform OUT body and return the exception message onException(MyFunctionalException.class) .handled(true) .transform(exceptionMessage());
// we catch MyFunctionalException and want to mark it as handled (= no failure returned to client)
// but we want to return a fixed text response, so we transform OUT body and return the exception message
onException(MyFunctionalException.class)
.handled(true)
.transform(exceptionMessage());
The exception message text is also accessible from the Simple language, through the
exception.message
variable. For example, you could embed the current exception text in a reply message, as follows:
The preceding
onException
clause can be expressed in XML DSL as follows:
Exception thrown while handling an exception 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
An exception that gets thrown while handling an existing exception (in other words, one that gets thrown in the middle of processing an
onException
clause) is handled in a special way. Such an exception is handled by the special fallback exception handler, which handles the exception as follows:
- All existing exception handlers are ignored and processing fails immediately.
- The new exception is logged.
- The new exception is set on the exchange object.
The simple strategy avoids complex failure scenarios which could otherwise end up with an
onException
clause getting locked into an infinite loop.
Scopes 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The
onException
clauses can be effective in either of the following scopes:
- RouteBuilder scope—
onException
clauses defined as standalone statements inside aRouteBuilder.configure()
method affect all of the routes defined in thatRouteBuilder
instance. On the other hand, theseonException
clauses have no effect whatsoever on routes defined inside any otherRouteBuilder
instance. TheonException
clauses must appear before the route definitions.All of the examples up to this point are defined using theRouteBuilder
scope. - Route scope—
onException
clauses can also be embedded directly within a route. These onException clauses affect only the route in which they are defined.
Route scope 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
You can embed an
onException
clause anywhere inside a route definition, but you must terminate the embedded onException
clause using the end()
DSL command.
For example, you can define an embedded
onException
clause in the Java DSL, as follows:
You can define an embedded
onException
clause in the XML DSL, as follows:
2.3.2. Error Handler 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Overview 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The
errorHandler()
clause provides similar features to the onException
clause, except that this mechanism is not able to discriminate between different exception types. The errorHandler()
clause is the original exception handling mechanism provided by Apache Camel and was available before the onException
clause was implemented.
Java DSL example 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The
errorHandler()
clause is defined in a RouteBuilder
class and applies to all of the routes in that RouteBuilder
class. It is triggered whenever an exception of any kind occurs in one of the applicable routes. For example, to define an error handler that routes all failed exchanges to the ActiveMQ deadLetter
queue, you can define a RouteBuilder
as follows:
Redirection to the dead letter channel will not occur, however, until all attempts at redelivery have been exhausted.
XML DSL example 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
In the XML DSL, you define an error handler within a
camelContext
scope using the errorHandler
element. For example, to define an error handler that routes all failed exchanges to the ActiveMQ deadLetter
queue, you can define an errorHandler
element as follows:
Types of error handler 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Table 2.1, “Error Handler Types” provides an overview of the different types of error handler you can define.
Java DSL Builder | XML DSL Type Attribute | Description |
---|---|---|
defaultErrorHandler() | DefaultErrorHandler | Propagates exceptions back to the caller and supports the redelivery policy, but it does not support a dead letter queue. |
deadLetterChannel() | DeadLetterChannel | Supports the same features as the default error handler and, in addition, supports a dead letter queue. |
loggingErrorChannel() | LoggingErrorChannel | Logs the exception text whenever an exception occurs. |
noErrorHandler() | NoErrorHandler | Dummy handler implementation that can be used to disable the error handler. |
TransactionErrorHandler | An error handler for transacted routes. A default transaction error handler instance is automatically used for a route that is marked as transacted. |
2.3.3. doTry, doCatch, and doFinally 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Overview 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
To handle exceptions within a route, you can use a combination of the
doTry
, doCatch
, and doFinally
clauses, which handle exceptions in a similar way to Java's try
, catch
, and finally
blocks.
Similarities between doCatch and Java catch 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
In general, the
doCatch()
clause in a route definition behaves in an analogous way to the catch()
statement in Java code. In particular, the following features are supported by the doCatch()
clause:
- Multiple doCatch clauses—you can have multiple
doCatch
clauses within a singledoTry
block. ThedoCatch
clauses are tested in the order they appear, just like Javacatch()
statements. Apache Camel executes the firstdoCatch
clause that matches the thrown exception.NoteThis algorithm is different from the exception matching algorithm used by theonException
clause—see Section 2.3.1, “onException Clause” for details. - Rethrowing exceptions—you can rethrow the current exception from within a
doCatch
clause using thehandled
sub-clause (see the section called “Rethrowing exceptions in doCatch”).
Special features of doCatch 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
There are some special features of the
doCatch()
clause, however, that have no analogue in the Java catch()
statement. The following features are specific to doCatch()
:
- Catching multiple exceptions—the
doCatch
clause allows you to specify a list of exceptions to catch, in contrast to the Javacatch()
statement, which catches only one exception (see the section called “Example”). - Conditional catching—you can catch an exception conditionally, by appending an
onWhen
sub-clause to thedoCatch
clause (see the section called “Conditional exception catching using onWhen”).
Example 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The following example shows how to write a
doTry
block in the Java DSL, where the doCatch()
clause will be executed, if either the IOException
exception or the IllegalStateException
exception are raised, and the doFinally()
clause is always executed, irrespective of whether an exception is raised or not.
Or equivalently, in Spring XML:
Rethrowing exceptions in doCatch 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
It is possible to rethrow an exception in a
doCatch()
clause by calling the handled()
sub-clause with its argument set to false
, as follows:
In the preceding example, if the
IOException
is caught by doCatch()
, the current exchange is sent to the mock:io
endpoint, and then the IOException
is rethrown. This gives the consumer endpoint at the start of the route (in the from()
command) an opportunity to handle the exception as well.
The following example shows how to define the same route in Spring XML:
Conditional exception catching using onWhen 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
A special feature of the Apache Camel
doCatch()
clause is that you can conditionalize the catching of exceptions based on an expression that is evaluated at run time. In other words, if you catch an exception using a clause of the form, doCatch(ExceptionList).doWhen(Expression)
, an exception will only be caught, if the predicate expression, Expression, evaluates to true
at run time.
For example, the following
doTry
block will catch the exceptions, IOException
and IllegalStateException
, only if the exception message contains the word, Severe
:
Or equivalently, in Spring XML:
Nested Conditions in doTry 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
There are various options available to add Camel exception handling to a JavaDSL route.
dotry()
creates a try or catch block for handling exceptions and is useful for route specific error handling.
If you want to catch the exception inside of
Copy to Clipboard
Copied!
Toggle word wrap
Toggle overflow
ChoiceDefinition
, you can use the following doTry
blocks:
2.3.4. Propagating SOAP Exceptions 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
Overview 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
The Camel CXF component provides an integration with Apache CXF, enabling you to send and receive SOAP messages from Apache Camel endpoints. You can easily define Apache Camel endpoints in XML, which can then be referenced in a route using the endpoint's bean ID. For more details, see CXF.
How to propagate stack trace information 링크 복사링크가 클립보드에 복사되었습니다!
링크 복사링크가 클립보드에 복사되었습니다!
It is possible to configure a CXF endpoint so that, when a Java exception is thrown on the server side, the stack trace for the exception is marshalled into a fault message and returned to the client. To enable this feaure, set the
dataFormat
to PAYLOAD
and set the faultStackTraceEnabled
property to true
in the cxfEndpoint
element, as follows:
For security reasons, the stack trace does not include the causing exception (that is, the part of a stack trace that follows
Caused by
). If you want to include the causing exception in the stack trace, set the exceptionMessageCauseEnabled
property to true
in the cxfEndpoint
element, as follows:
Warning
You should only enable the
exceptionMessageCauseEnabled
flag for testing and diagnostic purposes. It is normal practice for servers to conceal the original cause of an exception to make it harder for hostile users to probe the server.