Properties provide the means of accessing various information regarding a message
passing through the ESB. Also properties can be used to control the behaviour of the
ESB for a particular message as well.
Generic Properties
Property: synapse.isresponse
Name
synapse.isresponse
Possible Values
"true", "false"
Default Behavior
none
Scope
axis2
Description
Once this property is set to 'true' on a message, the ESB will start treating it
as a response message. It is generally used to route a request message back to its
source as the response.
By default the ESB adds a new set of WS-Addressing headers to the messages forwarded
from the ESB. If this property is set to 'true' on a message the ESB will forward it
without altering its existing WS-Addressing headers.
Same as synapse.isresponse property. It is recommended to use this property to flag
messages as responses instead of the synapse.isresponse property.
Example
<property name="RESPONSE" value="true"/>
Property: OUT_ONLY
Name
OUT_ONLY
Possible Values
"true", "false"
Default Behavior
none
Scope
synapse
Description
Set this property to 'true' on a message to indicate that no response message is
expected for it once it is forwarded from the ESB. In other words the ESB will do
an out-only invocation with such messages. It is very important to set this property
on messages that are involved in out-only invocations to prevent the ESB from registering
unnecessary callbacks for response handling and eventually running out of memory.
Example
<property name="OUT_ONLY" value="true"/>
Property: ERROR_CODE
Name
ERROR_CODE
Possible Values
string
Default Behavior
none
Scope
synapse
Description
Use this property to set a custom error code on a message which can be later processed
by a Synapse fault handler. If the Synapse encounters an error while mediation or
routing this property will be automatically populated.
Example
<property name="ERROR_CODE" value="100100"/>
Property: ERROR_MESSAGE
Name
ERROR_MESSAGE
Possible Values
string
Default Behavior
none
Scope
synapse
Description
Use this property to set a custom error message on a message which can be later
processed by a Synapse fault handler. If the Synapse encounters an error while
mediation or routing this property will be automatically populated.
Use this property to set the exception stacktrace in case of an error. If the ESB
encounters an error while mediation or routing this property will be automatically
populated.
Contains the actual exception thrown in case of a runtime error
Example
Property: TRANSPORT_HEADERS
Name
TRANSPORT_HEADERS
Possible Values
java.util.Map
Default Behavior
Populated with the transport headers of the incoming request
Scope
axis2
Description
Contains the map of transport headers. Automatically populated. Individual
values of this map can be accessed using the property mediator in the transport
scope.
Set this property to 'true' if you do not want the ESB to add WS-Addressing headers
to outgoing messages. This property can affect messages sent to backend services as
well as the responses routed back to clients.
By default Axis2 will spawn a new thread to handle each outgoing message. To change
this behavior remove this property from the message. Removal of this property could
be vital when queuing transports like JMS are involved.
In situations where the ESB is receiving HTTP response messages without the
Content-type header, this property can be used to specify a default content type
to be used. If no such content type is specified for responses the ESB will
default to 'application/octet-stream'.
In Case of GET requests this contains the query string
Scope
axis2
Description
The value of this property will be appended to the target URL when sending
messages out in RESTful manner. Useful when it is required to append a context
to the target URL in case of RESTful invocations.