Describe the restrictions placed on the use of SOAP by the WS-I Basic Profile 1.0a.
BP 1.0 - Messaging - XML Representation of SOAP Messages.
When a MESSAGE contains a soap:Fault element, that element MUST NOT have element
children other than faultcode, faultstring, faultactor and
detail.
CORRECT:
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/' >
<faultcode>soap:Client</faultcode>
<faultstring>Invalid message format</faultstring>
<faultactor>http://example.org/someactor</faultactor>
<detail>
<m:msg xmlns:m='http://example.org/faults/exceptions'>
There were <b>lots</b> of elements in the message that I did not understand
</m:msg>
<m:Exception xmlns:m='http://example.org/faults/exceptions'>
<m:ExceptionType>Severe</m:ExceptionType>
</m:Exception>
</detail>
</soap:Fault>
INCORRECT (not allowed child element inside Fault):
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/' >
<faultcode>soap:Client</faultcode>
<faultstring>Invalid message format</faultstring>
<faultactor>http://example.org/someactor</faultactor>
<detail>There were <b>lots</b> of elements in the message
that I did not understand
</detail>
<m:Exception xmlns:m='http://example.org/faults/exceptions' >
<m:ExceptionType>Severe</m:ExceptionType>
</m:Exception>
</soap:Fault>
When a MESSAGE contains a soap:Fault element its element children MUST be unqualified.
CORRECT:
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns='' >
<faultcode>soap:Client</faultcode>
<faultstring>Invalid message format</faultstring>
<faultactor>http://example.org/someactor</faultactor>
<detail>
<m:msg xmlns:m='http://example.org/faults/exceptions'>
There were <b>lots</b> of elements in the message that
I did not understand
</m:msg>
</detail>
</soap:Fault>
INCORRECT (child elements have namespace prefixes):
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/' >
<soap:faultcode>soap:Client</soap:faultcode>
<soap:faultstring>Invalid message format</soap:faultstring>
<soap:faultactor>http://example.org/someactor</soap:faultactor>
<soap:detail>
<m:msg xmlns:m='http://example.org/faults/exceptions'>
There were <b>lots</b> of elements in the message that
I did not understand
</m:msg>
</soap:detail>
</soap:Fault>
A RECEIVER MUST accept fault messages that have any number of ELEMENTS, including zero, appearing as children of the
detail element. Such children can be qualified or unqualified.
A RECEIVER MUST accept fault messages that have any number of qualified or unqualified ATTRIBUTES, including zero,
appearing on the detail element. The namespace of qualified attributes can be anything
other than "http://schemas.xmlsoap.org/soap/envelope/".
A RECEIVER MUST accept fault messages that carry an xml:lang attribute on the faultstring element.
When a MESSAGE contains a faultcode element the content of that element SHOULD be one of the fault codes
defined in SOAP 1.1 or a namespace qualified fault code.
SOAP 1.1 defines following faultcode values:
Table 2.3. SOAP Fault Codes
| Error | Description |
|---|
| VersionMismatch |
The processing party found an invalid namespace for the SOAP Envelope element.
|
| MustUnderstand | An immediate child element of the SOAP Header element that was either not understood
or not obeyed by the processing party contained a SOAP mustUnderstand attribute with a value of
"1".
|
| Client |
The Client class of errors indicate that the message was incorrectly formed or did not contain the appropriate
information in order to succeed. For example, the message could lack the proper authentication or payment
information. It is generally an indication that the message should not be resent without change.
|
| Server |
The Server class of errors indicate that the message could not be processed for reasons not directly attributable
to the contents of the message itself but rather to the processing of the message. For example, processing could
include communicating with an upstream processor, which didn't respond. The message may succeed at a later point
in time.
|
When a MESSAGE contains a faultcode element the content of that element SHOULD NOT use of
the SOAP 1.1 "dot" notation to refine the meaning of the Fault.
CORRECT (use of custom namespace qualified value):
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:c='http://example.org/faultcodes' >
<faultcode>c:ProcessingError</faultcode>
<faultstring>An error occured while processing the message
</faultstring>
</soap:Fault>
CORRECT (use of predefined SOAP 1.1 value):
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/' >
<faultcode>soap:Server</faultcode>
<faultstring>An error occured while processing the message
</faultstring>
</soap:Fault>
INCORRECT ("dot" notation):
<soap:Fault xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:c='http://example.org/faultcodes' >
<faultcode>soap:Server.ProcessingError</faultcode>
<faultstring>An error occurred while processing the message
</faultstring>
</soap:Fault>
A MESSAGE MUST NOT contain soap:encodingStyle attributes on any of the elements whose namespace name is
"http://schemas.xmlsoap.org/soap/envelope/".
A MESSAGE MUST NOT contain soap:encodingStyle attributes on any element that is a child of
soap:Body.
A MESSAGE described in an rpc-literal binding MUST NOT contain soap:encodingStyle attribute on any elements
are grandchildren of soap:Body.
A MESSAGE MUST NOT contain a Document Type Declaration (DTD).
A MESSAGE MUST NOT contain Processing Instructions (PI).
A RECEIVER MUST accept messages that contain an XML Declaration.
A MESSAGE MUST NOT have any element children of soap:Envelope following the soap:Body element.
CORRECT:
<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/' >
<soap:Body>
<p:Process xmlns:p='http://example.org/Operations' >
<m:Data xmlns:m='http://example.org/information' >
Here is some data with the message
</m:Data>
</p:Process>
</soap:Body>
</soap:Envelope>
INCORRECT (child elements after Body element):
<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/' >
<soap:Body>
<p:Process xmlns:p='http://example.org/Operations' />
</soap:Body>
<m:Data xmlns:m='http://example.org/information' >
Here is some data with the message
</m:Data>
</soap:Envelope>
A MESSAGE MUST be serialized as either UTF-8 or UTF-16.
The media type of a MESSAGE's envelope MUST indicate the correct character encoding, using the charset parameter.
A MESSAGE containing a soap:mustUnderstand attribute MUST only use the lexical forms "0" and "1".
The children of the soap:Body element in a MESSAGE MUST be namespace qualified.
A RECEIVER MUST generate a fault if they encounter a message whose document element has a local name of
"Envelope" but a namespace
name that is not "http://schemas.xmlsoap.org/soap/envelope/".
A RECEIVER MUST NOT mandate the use of the xsi:type attribute in
messages except as required in order to
indicate a derived type.
Visit
http://java.boot.by
for the updates.
