[CONF] Apache Camel > How can I stop a route from a route

[confluence]

How can I stop a route from a route Page edited by Claus Ibsen Changes (6) ... Stopping a route during routing an existing message is a bit tricky. The reason for that is Camel will [Graceful Shutdown] the route you are stopping. And if you do that while a message is being routed the [Graceful Shutdown] will try to wait until that message has been processed. Now that message can easily be yourself. So to cater for that you have to tell Camel that you are done routing this message which you do by removing it from the in flight registry. The follow code shows how you can stop a route from a [Processor]: {code:java} from("direct:start") .to("bean:foo?method=doSomething").routeId("myCoolRoute") .process(new Processor() { public void process(Exchange exchange) throws Exception { // remove myself from the in flight registry so we can stop this route without trouble context.getInflightRepository().remove(exchange); // stop this route context.stopRoute("myCoolRoute"); }); {code} The best practice for stopping a route from a route, is to either - signal to another thread to stop the route - spin off a new thread to stop the route *Important:* It is *not* best practice to stop a route as shown above, as stopping a route using the same thread that routes messages can be tricky. Its better to spin off a separate thread that stops the route, or to use a boolean flag, and then flip the flag, from the route. And then have another process that monitors that flag, and reacts, to stop the route. Using another thread to stop the route is also what is normally used when stopping Camel itself, or for example when an application in a server is stopped etc. Its too tricky and hard to stop a route using the same thread that currently is processing a message from the route. This is not advised to do, and can cause unforeseen side effects. h3. Using a latch to stop Camel from a route In this example we use a {{CountdownLatch}} to signal when Camel should stop, triggered from a route. {snippet:id=e1|lang=java|url="" And in the route we call the latch as shown: {snippet:id=e2|lang=java|url="" h3. Using a thread to stop a route from a route In this example we use a separate {{Thread}} to stop the route, triggered from the route itself. {snippet:id=e1|lang=java|url="" And in the route we create the thread and call the {{stopRoute}} method as shown: {snippet:id=e2|lang=java|url="" h3. Alternative solutions Camel provides another feature for managing routes at runtime which is [RoutePolicy]. ... Full Content How can I stop a route from a route The CamelContext provides API for managing routes at runtime. It has a stopRoute(id) and startRoute(id) methods. Stopping a route during routing an existing message is a bit tricky. The reason for that is Camel will Graceful Shutdown the route you are stopping. And if you do that while a message is being routed the Graceful Shutdown will try to wait until that message has been processed. The best practice for stopping a route from a route, is to either signal to another thread to stop the route spin off a new thread to stop the route Using another thread to stop the route is also what is normally used when stopping Camel itself, or for example when an application in a server is stopped etc. Its too tricky and hard to stop a route using the same thread that currently is processing a message from the route. This is not advised to do, and can cause unforeseen side effects. Using a latch to stop Camel from a route In this example we use a CountdownLatch to signal when Camel should stop, triggered from a route. Error formatting macro: snippet: java.lang.IndexOutOfBoundsException: Index: 20, Size: 20 And in the route we call the latch as shown: Error formatting macro: snippet: java.lang.IndexOutOfBoundsException: Index: 20, Size: 20 Using a thread to stop a route from a route In this example we use a separate Thread to stop the route, triggered from the route itself. Error formatting macro: snippet: java.lang.IndexOutOfBoundsException: Index: 20, Size: 20 And in the route we create the thread and call the stopRoute method as shown: Error formatting macro: snippet: java.lang.IndexOutOfBoundsException: Index: 20, Size: 20 Alternative solutions Camel provides another feature for managing routes at runtime which is RoutePolicy. And CamelContext also provides API for suspend/resume of routes, and shutdown as well. suspend/resume is faster than stop/start. For example a HTTP server will still run but deny any incoming requests. Where as if it was stopped the HTTP listener would have been stopped. shutdown means the route is being removed from CamelContext and cannot be started again. Its also removed from JMX. A route must have been stopped prior to be shutdown. See more details about the Lifecycle. See Also RoutePolicy Graceful Shutdown Lifecycle Change Notification Preferences View Online | View Changes | Add Comment