The Fault Mediator (also called the Makefault Mediator) transforms the current message into a fault message. However, this mediator does not send the converted message. The Send Mediator needs to be invoked to send a fault message created via the Fault mediator. The fault message's To
header is set to the Fault-To
of the original message (if such a header exists in the original message). You can create the fault message as a SOAP 1.1, SOAP 1.2, or plain-old XML (POX) fault.
For more information on faults and errors, see Error Handling.
Syntax
<makefault [version="soap11|soap12|pox"]> <code (value="literal" | expression="xpath")/> <reason (value="literal" | expression="xpath")> <node>? <role>? <detail>? </makefault>
UI Configuration
Click on the relevant tab to view the required UI configuration pending on whether you want to create the fault message as a SOAP 1.1 fault, SOAP 1.2 fault or a plain-old XML (POX) fault.
The parameters available to configure the Fault mediator to create a SOAP 1.1 fault are as follows.
Parameter Name | Description |
---|---|
Fault Code | This parameter is used to select the fault code for which the fault string should be defined. Possible values are as follows.
|
Fault String | The detailed fault string of the fault code. The following options are available.
Tip You can click NameSpaces to add namespaces if you are providing an expression. Then the Namespace Editor panel would appear where you can provide any number of namespace prefixes and URLs used in the XPath expression. |
Fault Actor | This parameter specifies the recipient of the fault message. If no value is entered for this parameter, the fault message will be sent to the recipient to whom the original message was being sent. |
Detail | This parameter is used to enter a custom description of the error. |
The parameters available to configure the Fault mediator to create a SOAP 1.2 fault are as follows.
Parameter Name | Description |
---|---|
Code | This parameter is used to select the fault code for which the reason should be defined. Possible values are as follows.
|
Reason | This parameter is used to specify the reason for the error code selected in the Code parameter. The following options are available.
Tip You can click NameSpaces to add namespaces if you are providing an expression. Then the Namespace Editor panel would appear where you can provide any number of namespace prefixes and URLs used in the XPath expression. |
Role | The SOAP 1.1 role name. |
Node | The SOAP 1.2 node name. |
Detail | This parameter is used to enter a custom description of the error. |
The parameters available to configure the Fault mediator to create a plain-old XML (POX) fault are as follows.
Parameter Name | Description |
---|---|
Reason | This parameter is used to enter a custom fault message. The following options are available.
Tip You can click NameSpaces to add namespaces if you are providing an expression. Then the Namespace Editor panel would appear where you can provide any number of namespace prefixes and URLs used in the XPath expression. |
Detail | This parameter is used to enter details for the fault message. The following options are available.
Tip You can click NameSpaces to add namespaces if you are providing an expression. Then the Namespace Editor panel would appear where you can provide any number of namespace prefixes and URLs used in the XPath expression. |
Note
You can configure the mediator using XML. Click switch to source view in the Mediator window.
Examples
In the following example, the test message
string value is given as the reason for the SOAP error versionMismatch
.
<makefault xmlns="http://ws.apache.org/ns/synapse" version="soap11"> <code xmlns:soap11Env="http://schemas.xmlsoap.org/soap/envelope/" value="soap11Env:VersionMismatch" /> <reason value="test message " /> <role></role> </makefault>
Samples
Sample 5: Creating SOAP Fault Messages and Changing the Direction of a Message.