blob: 536585593aa8c2de03724881fcf4317c666a6f10 [file] [log] [blame]
[[removeProperties-eip]]
= Remove Properties EIP
:page-source: core/camel-core-engine/src/main/docs/eips/removeProperties-eip.adoc
The RemoveProperties EIP allows you to remove Properties from you exchange.
== Options
// eip options: START
The Remove Properties EIP supports 2 options which are listed below:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *pattern* | *Required* Name or pattern of properties to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive). | | String
| *excludePattern* | Name or pattern of properties to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive). | | String
|===
// eip options: END
== Examples
The following example shows how to use the removeProperties EIP
[source,java]
----
RouteBuilder builder = new RouteBuilder() {
public void configure() {
from("direct:a")
.removeProperties("myProperty", "myProperty1")
.to("direct:b");
}
};
----
And the same example using XML:
[source,xml]
----
<camelContext xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="direct:a"/>
<removeProperties pattern="myProperty*"/>
<to uri="direct:b"/>
</route>
</camelContext>
----