Rollback

The Rollback EIP is used for marking an Exchange to rollback and stop continue routing the message.

Options

The Rollback eip supports 4 options, which are listed below.

Name Description Default Type

message

Message to use in rollback exception.

String

markRollbackOnly

Mark the transaction for rollback only (cannot be overruled to commit).

false

Boolean

markRollbackOnlyLast

Mark only last sub transaction for rollback only. When using sub transactions (if the transaction manager support this).

false

Boolean

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

description

Sets the description of this node.

DescriptionDefinition

Using Rollback

We want test message for some conditions and force a rollback if a message may be faulty.

In Java DSL we can do:

from("direct:start")
    .choice().when(body().contains("error"))
        .rollback("That do not work")
    .otherwise()
        .to("direct:continue");

And in XML DSL:

<route>
    <from uri="direct:start"/>
    <choice>
        <when>
            <simple>${body} contains 'error'</simple>
            <rollback message="That do not work"/>
        </when>
        <otherwise>
            <to uri="direct:continue"/>
        </otherwise>
    </choice>
</route>

When Camel is rolling back, then a RollbackExchangeException is thrown with the caused message "That do not work".

Marking for Rollback only

When a message is rolled back, then Camel will by default throw a RollbackExchangeException to cause the message to fail and rollback.

This behavior can be modified to only mark for rollback, and not throw the exception.

from("direct:start")
    .choice().when(body().contains("error"))
        .markRollbackOnly()
    .otherwise()
        .to("direct:continue");

And in XML DSL:

<route>
    <from uri="direct:start"/>
    <choice>
        <when>
            <simple>${body} contains 'error'</simple>
            <rollback markRollbackOnly="true"/>
        </when>
        <otherwise>
            <to uri="direct:continue"/>
        </otherwise>
    </choice>
</route>

Then no exception is thrown, but the message is marked to rollback and stopped continue routing.

Using Rollback with Transactions

Rollback can be used together with transactions. For more details see Transaction Client EIP.

Back to top