Generic Properties

Generic properties allow you to configure messages as they're processed by the ESB, such as marking a message as out-only (no response message will be expected), adding a custom error message or code to the message, and disabling WS-Addressing headers.

PRESERVE_WS_ADDRESSING

Name	PRESERVE_WS_ADDRESSING
Possible Values	"true", "false"
Default Behavior	none
Scope	synapse
Description	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.
Example	<property name="PRESERVE_WS_ADDRESSING" value="true"/>

RESPONSE

Name	RESPONSE
Possible Values	"true", "false"
Default Behavior	none
Scope	synapse
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.
Example	<property name="RESPONSE" value="true"/>

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"/>

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 during mediation or routing, this property will be automatically populated.
Example	<property name="ERROR_CODE" value="100100"/>

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 during mediation or routing, this property will be automatically populated.
Example	<log level="custom"> <property name="Cause" expression="get-property('ERROR_MESSAGE')"/> </log>

ERROR_DETAIL

Name	ERROR_DETAIL
Possible Values	string
Default Behavior	none
Scope	synapse
Description	Use this property to set the exception stacktrace in case of an error. If the ESB encounters an error during mediation or routing, this property will be automatically populated.
Example	<log level="custom"> <property name="Trace" expression="get-property('ERROR_DETAIL')"/> </log>

ERROR_EXCEPTION

Name	ERROR_EXCEPTION
Possible Values	java.lang.Exception
Default Behavior	none
Scope	synapse
Description	Contains the actual exception thrown in case of a runtime error.

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.
Example	<property name="TRANSPORT_HEADERS" action="remove" scope="axis2"/>

messageType

Name	messageType
Possible Values	string
Default Behavior	Content type of incoming request.
Scope	axis2
Description	Message formatter is selected based on this property. This property should have the content type, such as text/xml, application/xml, or application/json.
Example	<property name="messageType" value="text/xml" scope="axis2"/>

ContentType

Name	ContentType
Possible Values	string
Default Behavior	Value of the Content-type header of the incoming request.
Scope	axis2
Description	This property will be in effect only if the messageType property is set. If the messageType is set, the value of Content-Type HTTP header of the outgoing request will be chosen based on this property. Note that this property is required to be set only if the message formatter seeks it in the message formatter implementation.
Example	<property name="ContentType" value="text/xml" scope="axis2"/>

disableAddressingForOutMessages

Name	disableAddressingForOutMessages
Possible Values	"true", "false"
Default Behavior	false
Scope	axis2
Description	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.
Example	<property name="disableAddressingForOutMessages" value="true" scope="axis2"/>

DISABLE_SMOOKS_RESULT_PAYLOAD

Name	DISABLE_SMOOKS_RESULT_PAYLOAD
Possible Values	"true", "false"
Default Behavior	false
Scope	synapse
Description	If this property is set to `true`, the result of file content processing carried out by the Smooks Mediator will not be loaded into the message context. This is useful in situations where you want to avoid large memory growth/out of heap space issue that may occur when large files processed by the Smooks mediator are reprocessed. See VFS Transport for a proxy service configuration where this property is used.
Example	<property name="DISABLE_SMOOKS_RESULT_PAYLOAD" value="true" scope="default" type="STRING"/>

ClientApiNonBlocking

Name	ClientApiNonBlocking
Possible Values	"true", "false"
Default Behavior	true
Scope	axis2
Description	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. A VFS proxy that writes to a VFS endpoint should have this property set in order to hold the primary thread until the send happens.
Example	<property name="ClientApiNonBlocking" action="remove" scope="axis2"/>

transportNonBlocking

Name	transportNonBlocking
Possible Values	"true", "false"
Default Behavior	true
Scope	axis2
Description	This property works the same way as `ClientApiNonBlocking`. It is recommended to use `ClientApiNonBlocking` for this purpose instead of `transportNonBlocking` since the former uses the latest axis2 translations.
Example	<property name="transportNonBlocking" action="remove" scope="axis2" value="true"/>

TRANSPORT_IN_NAME

Name	TRANSPORT_IN_NAME
Scope	synapse
Description	Mediation logic can read incoming transport name using this property (since WSO2 ESB 4.7.0)
Example	<log level="custom"> <property name="INCOMING_TRANSPORT" expression="get-property('TRANSPORT_IN_NAME')"/> </log>

preserveProcessedHeaders

Name	preserveProcessedHeaders
Possible Values	"true", "false"
Default Behavior	Preserving SOAP headers
Scope	synapse(default)
Description	By default, Synapse removes the SOAP headers of incoming requests that have been processed. If we set this property to 'true', Synapse preserves the SOAP headers.
Example	<property name="preserveProcessedHeaders" value="true" scope="default"/>

SERVER_IP

Name	SERVER_IP
Possible Values	IP address or hostname of the ESB host
Default Behavior	Set automatically by the mediation engine upon startup
Scope	synapse

FORCE_ERROR_ON_SOAP_FAULT

Name	FORCE_ERROR_ON_SOAP_FAULT
Possible Values	"true", "false"
Default Behavior	true
Scope	synapse(default)
Description	When a SOAP error occurs in a response, the SOAPFault sent from the back end is received by the out sequence as a usual response by default. If this property is set to `true`, the SOAPFault is redirected to a fault sequence. Note that when this property is `true`, only properties in the 'operation' scope will be passed to the error handler, and other properties in the axis2 or default scopes will not be passed to the error handler.
Example	<property name="FORCE_ERROR_ON_SOAP_FAULT" value="true" scope="default" type="STRING"></property>