This text file contains sample code fragments from:
Section 11.5 - Fault Messages
Chapter 11 - Fundamental Message Design: SOAP Envelope Structure, Fault Messages, and Header Processing
Book - Web Service Contract Design & Versioning for SOA
Series - Prentice Hall Service-Oriented Computing Series from Thomas Erl
Site - www.soabooks.com


<soap:Envelope xmlns:soap=
  "http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>soap:VersionMismatch</soap:Value>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">
          Version Mismatch
        </soap:Text>
      </soap:Reason>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Example 11.15 - The soap:Code element indicating a version mismatch error.


<soap:Envelope xmlns:soap=
  "http://www.w3.org/2003/05/soap-envelope">
  <soap:Header>
    ...additional details...
  </soap:Header>
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>soap:MustUnderstand</soap:Value>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">
          Mandatory header(s) not understood
        </soap:Text>
      </soap:Reason>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Example 11.16 - The soap:MustUnderstand fault. Note the bolded soap:Header construct can provide further details as to why this fault occurred.


<soap:Envelope xmlns:soap=
  "http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>soap:Sender</soap:Value>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">
          Malformed message
        </soap:Text>
      </soap:Reason>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Example 11.17 - A fault that points to the sender of the message as the source of invalid message content that caused the exception.


<soap:Envelope xmlns:soap=
  "http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>soap:Receiver</soap:Value>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">
          Resource Unavailable
        </soap:Text>
      </soap:Reason>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Example 11.18 - The soap:Code construct indicating that the receiver of the message raised the fault due to an unavailable resource it likely required to process the message.


<soap:Envelope xmlns:soap=
  "http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>soap:DataEncodingUnknown</soap:Value>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">
          Unrecognized data encoding
        </soap:Text>
      </soap:Reason>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Example 11.19 - An unrecognized data encoding format causes a SOAP node to generate this fault message.


<soap:Envelope xmlns:soap=
  "http://www.w3.org/2003/05/soap-envelope"
  xmlns:sec="http://actioncon.com/security">
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>soap:Sender</soap:Value>
        <soap:Subcode>
          <soap:Value>sec:AuthenticationFailed</soap:Value>
        </soap:Subcode>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">
          User name not recognized.
        </soap:Text>
      </soap:Reason>
      <soap:Detail>
        <sec:InvalidUsername>anonymous</sec:InvalidUsername>
      </soap:Detail>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Example 11.20 - A soap:Detail construct containing custom elements.