Fault Mediator

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

Choose one of the following versions for the Fault Mediator:

SOAP 1.1

For this version, the following options are available:

Fault Code
- versionMismatch - SOAP version mismatch error.
- mustUnderstand - SOAP error regarding "must understand" error.
- Client - Client side error.
- Server - Server side error.
Value/Expression
Fault String- The detailed fault string of the fault code. It can be given either as a string value or an expression.

You can click the Namespaces link to add namespaces if you are providing an expression. You will be provided another panel named "Namespace Editor," where you can provide any number of namespace prefixes and URL that you have used in the XPath expression.
Fault Actor
Detail - Some information about the fault can be added to this field.

SOAP 1.2

For this version, the following options are available:

Code
- versionMismatch - SOAP version mismatch error.
- mustUnderstand - SOAP error regarding "must understand" error.
- dataEncodingUnknown - SOAP encoding error.
- Sender - Sender-side error.
- Receiver - Receiver-side error.
Value/Expression
Reason- Reason describing the fault code.

You can click on the "Namespaces" link to add namespaces if you are providing an expression. You will be provided another panel named "Namespace Editor," where you can provide any number of namespace prefixes and URL that you have used in the XPath expression.
Role - SOAP 1.2 role names.
Node - SOAP 1.2 node name.
Detail - Some information about the fault can be added to the field.

Plain-old XML (POX)

For this version, the following options are available:

Reason - The fault message. You can specify the reason as a string value or as an expression.

You can click the Namespaces link to add namespaces if you are providing an expression. You will be provided another panel named "Namespace Editor," where you can provide any number of namespace prefixes and URL that you have used in the XPath expression.
Detail - Optionally provide additional details about the fault.

You can configure the Mediator using XML. Click on "switch to source view" in the "Mediator" window.

Example

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