Hybrid Integration 10.1 | Integrating On-Premises Applications | Integration Server Built-In Services | SOAP Folder | pub.soap.utils:addHeaderEntry
 
pub.soap.utils:addHeaderEntry
WmPublic. Inserts an entry into the header element of a SOAP message.
Input Parameters
soapData
Object SOAP object to which you want the header entry added.
headerEntry
com.wm.lang.xml.Node XML node containing the entry that you want to add to soapData.
Note: An XML node is a parsable representation of a node in an XML document. You generate an XML node using services such as pub.xml:xmlStringToXMLNode.
Important: This service adds a single header entry to a SOAP object. If you need to add more than one entry, execute addHeaderEntry once for each entry.
Important: In webMethods Integration Server versions 6.0.1 and later, this service expects the node in headerEntry to be namespace qualified. If the node is not qualified, the service throws an exception. If you created solutions based on the earlier behavior of this service (which permitted non-qualified entries), you can disable namespace enforcement by setting the server's watt.server.SOAP.EnforceMsgPartNS parameter to false.
mustUnderstand
String Optional. Value to which you want the mustUnderstand attribute set.
The mustUnderstand attribute 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.
A value of:
*0 indicates that the header is optional.
*1 indicates that the header is mandatory.
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/.
Note: If you do not set mustUnderstand, the mustUnderstand attribute is omitted from the header entry, which is equivalent to setting mustUnderstand to 0.
actor
String Optional. Value to which you want the actor attribute set.
The actor attribute specifies a URI that identifies the recipient to which a header entry is targeted. 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/.
Output Parameters
soapData
Object SOAP object to which the header entry was added.
Usage Notes
A SOAP object is an object that represents a SOAP message.
If you are composing a new SOAP message, you must first create an empty SOAP object (called soapData) with the createSoapData service and then add your header entries to with pub.soap.utils:addHeaderEntry.
If you are composing a SOAP response, you use addHeaderEntry to populate the soapResponseData object that the SOAP message handler generates and puts in the pipeline.
See Also
pub.soap.utils:createSoapData
pub.soap.utils:addBodyEntry
pub.soap.utils:addTrailer
pub.soap.utils:getHeader
pub.soap.utils:getHeaderEntries
Examples
See the following in the WmSamples packages in the certified samples area of the Knowledge Center on the Empower Product Support website at https://empower.softwareag.com:
sample.soap:buildMsg_sendHTTP
sample.soap:targetSvc_defaultProc
Copyright © 2015- 2017 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.