[[ErrorHandler-ErrorHandler]]
= Error Handler

Camel supports pluggable
https://www.javadoc.io/doc/org.apache.camel/camel-base/current/org/apache/camel/processor/ErrorHandler.html[ErrorHandler]
strategies to deal with errors processing an
Event Driven Consumer. An alternative
is to specify the error handling directly in the DSL
using the Exception Clause.

For introduction and background material see
Error handling in Camel.

*Exception Clause*

Using Error Handler combined with
Exception Clause is a very powerful
combination. We encourage end-users to use this combination in your
error handling strategies. See samples and
Exception Clause.

*Using try ... catch ... finally*

Related to error handling is the xref:try-catch-finally.adoc[Try Catch
Finally] as DSL you can use directly in your route. Its basically a
mimic of the regular try catch finally in the Java language but with
more power.

The current implementations Camel provides out of the box are:

[[ErrorHandler-Nontransacted]]
== Non transacted

* DefaultErrorHandler is the default
error handler in Camel. This error handler does not support a dead
letter queue, it will propagate exceptions back to the caller, as if
there where no error handler at all. It has a limited set of features.
* Dead Letter Channel which supports
attempting to redeliver the message exchange a number of times before
sending it to a dead letter endpoint
* NoErrorHandler for no error handling

[[ErrorHandler-Transacted]]
== Transacted

* TransactionErrorHandler is the
default error handler in Camel for transacted routes. See the
Transactional Client EIP pattern.

These error handlers can be applied in the DSL to an
entire set of rules or a specific routing rule as we show in the next
examples. Error handling rules are inherited on each routing rule within
a single RouteBuilder

[[ErrorHandler-ShortSummaryoftheprovidedErrorHandlers]]
== Short Summary of the provided Error Handlers

=== DefaultErrorHandler

The DefaultErrorHandler is the default
error handler in Camel. Unlike xref:{eip-vc}:eips:dead-letter-channel.adoc[Dead Letter
Channel] it does not have any dead letter queue, and do *not* handle
exceptions by default.

=== Dead Letter Channel

The Dead Letter Channel will redeliver at
most 6 times using 1 second delay, and if the exchange failed it will be
logged at ERROR level.

You can configure the default dead letter endpoint to use:

or in Spring DSL

[source,xml]
-----------------------------------------------------------------------------------------------------
<bean id="deadLetterErrorHandler" class="org.apache.camel.builder.DeadLetterChannelBuilder">
  <property name="deadLetterUri" value="log:dead"/>
</bean>

<camelContext errorHandlerRef="deadLetterErrorHandler" xmlns="http://camel.apache.org/schema/spring">
  ...
</camelContext>
-----------------------------------------------------------------------------------------------------

or also from *Camel 2.3.0 onwards*

[source,xml]
--------------------------------------------------------------------------------------------------
<camel:errorHandler id="deadLetterErrorHandler" type="DeadLetterChannel" deadLetterUri="log:dead">

<camel:camelContext errorHandlerRef="deadLetterErrorHandler">
  ...
</camel:camelContext>
--------------------------------------------------------------------------------------------------

[[ErrorHandler-NoErrorHandler]]
=== No Error Handler

The no error handler is to be used for disabling error handling.

[source,java]
-------------------------------
errorHandler(noErrorHandler());
-------------------------------

or in Spring DSL

[source,xml]
---------------------------------------------------------------------------------------------
<bean id="noErrorHandler" class="org.apache.camel.builder.NoErrorHandlerBuilder"/>

<camelContext errorHandlerRef="noErrorHandler" xmlns="http://camel.apache.org/schema/spring">
  ...
</camelContext>
---------------------------------------------------------------------------------------------

or also from *Camel 2.3.0 onwards*

[source,xml]
---------------------------------------------------------------
<camel:errorHandler id="noErrorHandler" type="NoErrorHandler"/>

<camel:camelContext errorHandlerRef="noErrorHandler">
  ...
</camel:camelContext>
---------------------------------------------------------------

[[ErrorHandler]]
=== TransactionErrorHandler

The TransactionErrorHandler is the
default error handler in Camel for transacted routes.

TIP:If you have marked a route as transacted using the *transacted* DSL then
Camel will automatic use a
TransactionErrorHandler. It will try
to lookup the global/per route configured error handler and use it if
its a `TransactionErrorHandlerBuilder` instance. If not Camel will
automatic create a temporary
TransactionErrorHandler that
overrules the default error handler. This is convention over
configuration.

[[ErrorHandler-Featuressupportbyvariouss]]
== Features support by various Error Handlers

Here is a breakdown of which features is supported by the
Error Handler(s):

[width="100%",cols="20%,80%",options="header",]
|=======================================================================
|Feature |Supported by the following Error Handler

|all scopes |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|onException |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|onWhen |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|continued |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|handled |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|Custom ExceptionPolicy |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|useOriginalBody |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|retryWhile |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|onRedelivery |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|RedeliveryPolicy |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|asyncDelayedRedelivery |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|redeliverWhileStopping |DefaultErrorHandler,
TransactionErrorHandler,
Dead Letter Channel

|dead letter queue |Dead Letter Channel

|onPrepareFailure |DefaultErrorHandler,
Dead Letter Channel

|=======================================================================

See Exception Clause documentation for
documentation of some of the features above.

[[ErrorHandler-Scopes]]
== Scopes

The error handler is scoped as either

* global (within the RouteBuilder)
* per route

The following example shows how you can register a global error handler:

[source,java]
---------------------------------------------------------------
RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("seda:error"));

        // here is our regular route
        from("seda:a").to("seda:b");
    }
};
---------------------------------------------------------------

The following example shows how you can register a route specific error
handler

[source,java]
---------------------------------------------------------------
RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        // this route is using a nested error handler
        from("seda:a")
            // here we configure the error handler
            .errorHandler(deadLetterChannel("seda:error"))
            // and we continue with the routing here
            .to("seda:b");

        // this route will use the default error handler
        from("seda:b").to("seda:c");
    }
};
---------------------------------------------------------------

[[ErrorHandler-Springbasedconfiguration]]
== Spring based configuration

*Java DSL vs. Spring DSL*
The error handler is configured a bit differently in Java DSL and Spring
DSL. Spring DSL relies more on standard Spring bean configuration
whereas Java DSL uses fluent builders.


The error handler can be configured as a spring bean and scoped in:

* global (the camelContext tag)
* per route (the route tag)
* or per policy (the policy/transacted tag)

The error handler is configured with the `errorHandlerRef` attribute.

TIP:*Error Handler Hierarchy*
The error handlers is inherited, so if you only have set a global error
handler then its use everywhere. But you can override this in a route
and use another error handler.

[[ErrorHandler-Springbasedconfigurationsample]]
=== Spring based configuration sample

In this sample we configure a xref:{eip-vc}:eips:dead-letter-channel.adoc[Dead Letter
Channel] on the route that should redeliver at most 3 times and use a
little delay before retrying. First we configure the reference to *myDeadLetterErrorHandler* using
the `errorHandlerRef` attribute on the `route` tag.

Then we configure *myDeadLetterErrorHandler* that is our
Dead Letter Channel. This configuration
is standard Spring using the bean element. +
 And finally we have another spring bean for the redelivery policy where
we can configure the options for how many times to redeliver, delays
etc.

From Camel 2.3.0, camel provides a customer bean configuration for the
Error Handler, you can find the examples here.

[[ErrorHandler-Usingthetransactionalerrorhandler]]
== Using the transactional error handler

The transactional error handler is based on spring transaction. This
requires the usage of the camel-spring component. +
 See Transactional Client that has many
samples for how to use and transactional behavior and configuration with
this error handler.

