Set Property

The SetProperty EIP is used for setting a Exchange property.

An Exchange property is a key/value set as a Map on the org.apache.camel.Exchange instance. This is not for setting property placeholders.

Options

The Set Property eip supports 2 options, which are listed below.

Name Description Default Type

name

Required Name of exchange property to set a new value. The simple language can be used to define a dynamic evaluated exchange property name to be used. Otherwise a constant name will be used.

String

expression

Required Expression to return the value of the message exchange property.

ExpressionDefinition

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

Example

The following example shows how to set a property on the exchange in a Camel route:

from("direct:a")
    .setProperty("myProperty", constant("test"))
    .to("direct:b");

And the same example using XML:

<route>
    <from uri="direct:a"/>
    <setProperty name="myProperty">
        <constant>test</constant>
    </setProperty>
    <to uri="direct:b"/>
</route>

Setting an exchange property from another exchange property

You can also set an exchange property with the value from another exchange property.

In the example we set the exchange property foo with the value from an existing exchange property named bar.

from("direct:a")
    .setProperty("foo", exchangeProperty("bar"))
    .to("direct:b");

And in XML:

<route>
    <from uri="direct:a"/>
    <setProperty name="foo">
        <exchangeProperty>bar</exchangeProperty>
    </setProperty>
    <to uri="direct:b"/>
</route>

Setting an exchange property with the current message body

It is of course also possible to set an exchange property with a value from anything on the Exchange such as the message body:

from("direct:a")
    .setProperty("myBody", body())
    .to("direct:b");

And in XML we use the Simple language to refer to the message body:

<route>
    <from uri="direct:a"/>
    <setProperty name="myBody">
        <simple>${body}</simple>
    </setProperty>
    <to uri="direct:b"/>
</route>
Back to top