Stop

How can I stop routing a message?

image

Use a special filter to mark the message to be stopped.

Options

The Stop eip supports 0 options, which are listed below.

Name Description Default Type

description

Sets the description of this node.

String

disabled

Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.

false

Boolean

Exchange properties

The Stop eip has no exchange properties.

Using Stop

We want to stop routing a message if the message body contains the word Bye. In the Content-Based Router below we use stop in such a case.

  • Java

  • XML

from("direct:start")
    .choice()
        .when(body().contains("Hello")).to("mock:hello")
        .when(body().contains("Bye")).to("mock:bye").stop()
        .otherwise().to("mock:other")
    .end()
.to("mock:result");
<route>
  <from uri="direct:start"/>
  <choice>
    <when>
      <simple>${body} contains 'Hello'</simple>
      <to uri="mock:hello"/>
    </when>
    <when>
      <simple>${body} contains 'Bye'</simple>
      <stop/>
    </when>
    <otherwise>
      <to uri="mock:other"/>
    </otherwise>
  </choice>
</route>

Calling stop from Java

You can also mark an Exchange to stop being routed from Java with the following code:

Exchange exchange = ...
exchange.setRouteStop(true);