DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Newsletter
Log In / Join
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Related

  • Testing Java and Spring Applications With Kotlin: Low-Risk to Adoption
  • Finally, an ORM That Matches Modern Architectural Patterns!
  • How Stalactite ORM Implements Its Fluent DSL
  • Implementing PEG in Java

Trending

  • The Man Who Invented Selenium Also Built Its Replacement
  • Columnar Formats for AI Telemetry: Parquet vs Vortex With DuckDB
  • How Performance Engineers Find and Fix Hidden System Bottlenecks
  • How to Keep AI Agents From Going Rogue Using Docker Sandbox

Draft This article hasn't been published, so readers can't see it.

In moderation This article is waiting for review, so readers can't see it yet.

Deleted This article has been deleted, so readers can't see it.

  1. DZone
  2. Coding
  3. Java
  4. Camel Exception Handling Overview for a Java DSL

Camel Exception Handling Overview for a Java DSL

By 
Ben O'Day
·
Apr. 25, 12 · Interview
Post on X (opens in a new tab) Share on LinkedIn (opens in a new tab)
66.7K Views

Join the DZone community Save articles, join the discussion, and download Refcards and Trend Reports with a free account.

Join for free Already a member? Log in
Here are some notes on adding Camel (from v2.3+) exception handling to a JavaDSL route.  There are various approaches/options available.  These notes cover the important distinctions between approaches...

Default handling
The default mode uses the DefaultErrorHandler strategy which simply propagates any exception back to the caller and ends the route immediately.  This is rarely the desired behavior, at the very least, you should define a generic/global exception handler to log the errors and put them on a queue for further analysis (during development, testing, etc).

onException(Exception)
    .to("log:GeneralError?level=ERROR")
    .to("activemq:queue:GeneralErrorQueue");


Try-catch-finally
This approach mimics the Java for exception handling and is designed to be very readable and easy to implement.  It inlines the try/catch/finally blocks directly in the route and is useful for route specific error handling.

from("direct:start")
    .doTry()
        .process(new MyProcessor())
    .doCatch(Exception.class)
        .to("mock:error");
    .doFinally()
        .to("mock:end");

onException
This approach defines the exception clause separately from the route.  This makes the route and exception handling code more readable and reusable.  Also, the exception handling will apply to any routes defined in its CamelContext.

onException(Exception.class)
    .to("mock:error");

from("direct:start") .process(new MyProcessor()) .to("mock:end");

 

Handled/Continued
These APIs provide valuable control over the flow.   Adding handled(true) tells Camel to not propagate the error back to the caller (should almost always be used).  The continued(true) tells Camel to resume the route where it left off (rarely used, but powerful).  These can both be used to control the flow of the route in interesting ways, for example...

from("direct:start")
    .process(new MyProcessor())
    .to("mock:end");

//send the exception back to the client (rarely used, clients need a meaningful response)
onException(ClientException.class)
    .handled(false)    //default
    .log("error sent back to the client");

//send a readable error message back to the client and handle the error internally
onException(HandledException.class)
    .handled(true)
    .setBody(constant("error"))
    .to("mock:error");

//ignore the exception and continue the route (can be dangerous, use wisely)
onException(ContinuedException.class)
    .continued(true);


Using a processor for more control
If you need more control of the handler code, you can use an inline Processor to get a handle to the exception that was thrown and write your own handler code...

onException(Exception.class)
.handled(true) .process(new Processor() { public void process(Exchange exchange) throws Exception { Exception exception = (Exception) exchange.getProperty(Exchange.EXCEPTION_CAUGHT); //log, email, reroute, etc. } });


Summary
Overall, the exception handling is very flexible and can meet almost any scenario you can come up with.  For the sake of focusing on the basics, many advanced features haven't been covered here.
  
For more details, see these pages on Camel's site...

http://camel.apache.org/error-handling-in-camel.html
http://camel.apache.org/try-catch-finally.html
http://camel.apache.org/exception-clause.html
Domain-Specific Language Java (programming language)

Published at DZone with permission of Ben O'Day. See the original article here.

Opinions expressed by DZone contributors are their own.

Related

  • Testing Java and Spring Applications With Kotlin: Low-Risk to Adoption
  • Finally, an ORM That Matches Modern Architectural Patterns!
  • How Stalactite ORM Implements Its Fluent DSL
  • Implementing PEG in Java

Partner Resources

×

Comments

Loading comments

The comments didn't load

Please try again in a moment.

Likes

Loading

The next likes didn't load. Please try again.

The likes didn't load

Please try again in a moment.

See who liked this

Log in or join DZone for free to see who liked this article.

Log in Join for free
  • RSS
  • X
  • Facebook

ABOUT US

  • About DZone
  • Support and feedback
  • Community research

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 215
  • Nashville, TN 37211
  • [email protected]

Let's be friends:

  • RSS
  • X
  • Facebook