Page Comparison

...

Generic properties allow you to configure messages as they're processed by the ESB profile, 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 profile adds a new set of WS-Addressing headers to the messages forwarded from the ESB profile. If this property is set to "true" on a message, the ESB profile will forward it without altering its existing WS-Addressing headers.

Example

Code Block
<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 profile 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

Code Block
<property name="RESPONSE" value="true"/>

OUT_ONLY

Name	OUT_ONLY
Possible Values	"true", "false"
Default Behavior	none
Scope	synapse
Description for value="true"	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 profile. In other words, the ESB profile 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 profile from registering unnecessary callbacks for response handling and eventually running out of memory.

Example

Code Block
<property name="OUT_ONLY" value="true"/>

Description for value="false"

Set this property to "false" to call the endpoint and get a response once it is forwarded from the ESB.

Code Block
<property name="OUT_ONLY" value="

true

false"/>

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

Code Block
<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

Code Block
<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 profile encounters an error during mediation or routing, this property will be automatically populated.

Example

Code Block
<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

Code Block
<property name="TRANSPORT_HEADERS" action="remove" scope="axis2"/>

Anchor

	messageType
	messageType

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

Code Block
<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

Code Block
<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 profile 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

Code Block
<property name="disableAddressingForOutMessages" value="true" scope="axis2"/>

Anchor
DISABLE_SMOOKS_RESULT_PAYLOAD
DISABLE_SMOOKS_RESULT_PAYLOAD
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

Code Block
<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 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.

Example

Code Block
<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

Code Block
<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

Code Block
<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

Code Block
<property name="preserveProcessedHeaders" value="true" scope="default"/>

SERVER_IP

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

FORCE_ERROR_ON_SOAP_FAULT
Anchor
SOAP fault
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

Code Block
<property name="FORCE_ERROR_ON_SOAP_FAULT" value="true" scope="default" type="STRING"></property>

QUOTE_STRING_IN_PAYLOAD_FACTORY_JSON

Name

QUOTE_STRING_IN_PAYLOAD_FACTORY_JSON

Possible Values

"true", "false"

Default Behavior

none

Scope

synapse

Description

When you create a JSON payload using the PayloadFactory mediator, a string value evaluated from an argument is replaced as it is. If you want to force double quotes to be added to a string value evaluated from an argument, set this property to true.

Info

title	Note

Double quotes are added only if the value evaluated from an argument is string. If the value is a valid JSON number, boolean value or null, double quotes are not added.

Example

Code Block
<property name="QUOTE_STRING_IN_PAYLOAD_FACTORY_JSON" value="true"/>

Versions Compared

Old Version 1

New Version Current

Key

PRESERVE_WS_ADDRESSING

RESPONSE

OUT_ONLY

ERROR_CODE

ERROR_MESSAGE

ERROR_DETAIL

ERROR_EXCEPTION

TRANSPORT_HEADERS

messageType

ContentType

disableAddressingForOutMessages

Anchor
DISABLE_SMOOKS_RESULT_PAYLOAD
DISABLE_SMOOKS_RESULT_PAYLOAD
DISABLE_SMOOKS_RESULT_PAYLOAD

ClientApiNonBlocking

transportNonBlocking

TRANSPORT_IN_NAME

preserveProcessedHeaders

SERVER_IP

FORCE_ERROR_ON_SOAP_FAULT
Anchor
SOAP fault
SOAP fault

QUOTE_STRING_IN_PAYLOAD_FACTORY_JSON

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

PRESERVE_WS_ADDRESSING

RESPONSE

OUT_ONLY

ERROR_CODE

ERROR_MESSAGE

ERROR_DETAIL

ERROR_EXCEPTION

TRANSPORT_HEADERS

messageType

ContentType

disableAddressingForOutMessages

AnchorDISABLE_SMOOKS_RESULT_PAYLOADDISABLE_SMOOKS_RESULT_PAYLOAD DISABLE_SMOOKS_RESULT_PAYLOAD

ClientApiNonBlocking

transportNonBlocking

TRANSPORT_IN_NAME

preserveProcessedHeaders

SERVER_IP

FORCE_ERROR_ON_SOAP_FAULT AnchorSOAP faultSOAP fault

QUOTE_STRING_IN_PAYLOAD_FACTORY_JSON

Anchor
DISABLE_SMOOKS_RESULT_PAYLOAD
DISABLE_SMOOKS_RESULT_PAYLOAD
DISABLE_SMOOKS_RESULT_PAYLOAD

FORCE_ERROR_ON_SOAP_FAULT
Anchor
SOAP fault
SOAP fault