Property Mediator
The property mediator has no direct impact on the message but rather on the message context flowing through Synapse.
The properties set on a message can be later retrieved through the synapse:get-property(prop-name) XPath extension
function.
If a scope is specified for a property, the property could be set as a transport header property or an (underlying)
Axis2
message context property, or as a Axis2 client option. If a scope is not specified, it will default to the Synapse
message
context scope. Using the property element with action specified as "remove" you can remove any existing message
context properties.
Property Mediator Screenshot
You have the following configuration under the property mediator.
-
Name: A name for the property. You can return the value of the property by calling get-property(property-name)
xpath extension function.
-
Action: The action to do. Possible values are
-
Add: Add a new property
-
Remove: Remove the property with the given name
-
Set Action As: Specify which type of value to store. Possible values are
-
Value : A static text value
-
Expression: XPath expression to evaluate
If there are any namespaces involved in the XPath expression, you can specify it in the Namespace
Editor.
Namespace Editor Screenshot
-
Type : Specify the type of the property. Possible values are
- STRING
- INTEGER
- BOOLEAN
- DOUBLE
- FLOAT
- LONG
- SHORT
- OM
Property mediator will handle the property as a property of selected type. In default, property mediator will
consider any property as a STRING type property.
- Pattern : Specify a regular expression what will evaluate against value of the property or result of the XPath
expression.
- Group : Number (Index) of the matching item evaluated using regular expression given in "Pattern"
-
Scope : Specify the scope the property is valid. Possible values are