pub.soap.utils:getMustUnderstand

Integration Server 10.5 | Built-In Services Reference Guide | SOAP Folder | Summary of Elements in this Folder | pub.soap.utils:getMustUnderstand

WmPublic. Returns the mustUnderstand status for a given header entry.

The mustUnderstand status specifies whether recipients are required to process a header entry (that is, whether processing of the entry is mandatory or optional). Recipients that cannot process a mandatory header entry must reject the message and return a SOAP fault. (See the pub.soap.utils:exitUnableToUnderstand service.)

Input Parameters

headerEntry

com.wm.lang.xml.Node The header entry whose mustUnderstand status you want to retrieve.

If you use pub.soap.utils:getHeaderEntries to retrieve header entries, you can loop over the list of header nodes to check the status of each entry.

If you use pub.soap.utils:getHeader to retrieve header entries, you will need to query the node returned by that service (using the pub.xml:queryXMLNode service) to extract a node for an individual header entry. Then you can run pub.soap.utils:getMustUnderstand on the resulting node.

Output Parameters

mustUnderstand

String Header entry's mustUnderstand status. If the header entry has a mustUnderstand attribute, mustUnderstand will return one of the following values:

0 indicates that the header is optional.

1 indicates that the header is mandatory.

If the header entry does not have a mustUnderstand attribute, mustUnderstand will return 0.

Usage Notes

For additional information about the mustUnderstand attribute, see the Simple Object Access Protocol (SOAP) 1.1 - W3C Note 08 May 2000 at http://www.w3.org/TR/SOAP/ and for SOAP 1.2, see the SOAP 1.2 W3C Recommendation 27 April 2007 at http://www.w3.org/TR/soap12-part1/.