Page Comparison

PRESERVE_WS_ADDRESSING

"true", "false"

none

synapse

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.

RESPONSE

"true", "false"

none

synapse

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.

OUT_ONLY

"true", "false"

none

synapse

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.

ERROR_CODE

string

none

synapse

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.

ERROR_MESSAGE

string

none

synapse

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.

ERROR_DETAIL

string

none

synapse

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.

ERROR_EXCEPTION

java.lang.Exception

none

synapse

Contains the actual exception thrown in case of a runtime error.

TRANSPORT_HEADERS

java.util.Map

Populated with the transport headers of the incoming request.

axis2

Contains the map of transport headers. Automatically populated. Individual values of this map can be accessed using the property mediator in the transport scope.

messageType

string

Content type of incoming request.

axis2

Message formatter is selected based on this property. This property should have the content type, such as text/xml, application/xml, or application/json.

ContentType

string

Value of the Content-type header of the incoming request.

axis2

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.

disableAddressingForOutMessages

"true", "false"

false

axis2

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.

ClientApiNonBlocking

"true", "false"

true

axis2

By default, Axis2

spawns a new thread to handle each outgoing message

. This property holds the primary thread until a VFS proxy writes to a VFS endpoint. You need to remove this property from the message

to change this behavior when queuing transports like JMS are involved.

transportNonBlocking

"true", "false"

true

axis2

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.

TRANSPORT_IN_NAME

synapse

Mediation logic can read incoming transport name using this property (since WSO2 ESB 4.7.0)

preserveProcessedHeaders

"true", "false"

Preserving SOAP headers

synapse(default)

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.

SERVER_IP

IP address or hostname of the ESB host

Set automatically by the mediation engine upon startup

synapse

FORCE_ERROR_ON_SOAP_FAULT

"true", "false"

true

synapse(default)

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.