Enterprise Service Bus 4.9.0

All docs This doc
Expand all   Collapse all
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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 NameDescription
 Fault Code

 This parameter is used to select the fault code for which the fault string should be defined. Possible values are as follows.

  • versionMismatch: Select this to specify the fault string for a SOAP version mismatch.
  • mustUnderstand: Select this to specify the fault string for the mustUnderstand error in SOAP.
  • Client: Select this to specify the fault string for client side errors.
  • Server: Select this to specify the fault string for server side errors.
 Fault String

The detailed fault string of the fault code. The following options are available.

  • value: If this option is selected, the fault string is specified as a string value.
  • expression: If this option is selected, the fault string is specified as an expression.

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 ActorThis 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.
 DetailThis 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 NameDescription
 Code

 This parameter is used to select the fault code for which the reason should be defined. Possible values are as follows.

  • versionMismatch: Select this to specify the reason for a SOAP version mismatch.
  • mustUnderstand: Select this to specify the reason for the mustUnderstand error in SOAP.
  • dataEncodingUnknown: Select this to specify the reason for a SOAP encoding error.
  • Sender: Select this ti specify the reason for a sender-side error.
  • Receiver: Select this to specify the reason for a receiver-side error.
 ReasonThis parameter is used to specify the reason for the error code selected in the Code parameter. The following options are available.
  • value: If this option is selected, the reason is specified as a string value.
  • expression: If this option is selected, the reason is specified as an expression.

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. 

 RoleThe SOAP 1.1 role name.
 NodeThe SOAP 1.2 node name.
 DetailThis 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 NameDescription
 Reason

This parameter is used to enter a custom fault message. The following options are available.

  • value: If this option is selected, the fault message is specified as a string value.
  • expression: If this option is selected, the fault message is specified as an expression.

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.

  • value: If this option is selected, the detail is specified as a string value.
  • expression: If this option is selected, the detail is specified as an expression.

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.


  • No labels