Try OpenEdge Now
skip to main content
Web Services
Creating ABL Clients to Consume OpenEdge SOAP Web Services : Handling SOAP Message Headers in ABL : Attributes and methods for handling SOAP headers : SOAP header-entryref object attributes and methods
 
SOAP header-entryref object attributes and methods
The following table briefly describes all of the attributes on the SOAP header-entryref object that are unique to the object or have special application to the SOAP header-entryref object.
Note: As indicated in Table 34 and Table 35, certain members are associated with a specific SOAP version. To determine which SOAP version is in use, use the SOAP-VERSION attribute of the server object handle.
Table 34. SOAP header-entryref object attributes
Attribute
Type
Description
ACTOR
CHARACTER
(SOAP Version 1.1 only) Returns the value of the actor attribute specified in the associated SOAP header entry, which identifies the recipient of the message. Replaced in SOAP Version 1.2 by the ROLE attribute, and assumes the value of that attribute if used in the context of a SOAP 1.2 connection.
LOCAL-NAME
CHARACTER
Returns the unqualified part of name specified for the associated SOAP header entry element.
MUST-UNDERSTAND
LOGICAL
Returns the value of the mustUnderstand attribute specified in the associated SOAP header entry.
NAME
CHARACTER
Returns the qualified name of the SOAP header entry ("namespacePrefix:localName").
NAMESPACE-URI
CHARACTER
Returns the namespace URI prefixed to the associated SOAP header entry element's name.
ROLE
CHARACTER
(SOAP Version 1.2 only) Returns the value of the role attribute specified in the associated SOAP header entry, which identifies the recipient of the message. Replaces the ACTOR attribute used in SOAP Version 1.1.
TYPE
CHARACTER
Returns the handle type, "SOAP-HEADER-ENTRYREF".
The following table briefly describes all of the methods on the SOAP header-entryref object.
Table 35. SOAP header-entryref object methods
Method
Type
Description
DELETE-HEADER-ENTRY ( )
LOGICAL
Deletes the underlying SOAP header entry and all of its content, but does not delete the SOAP header-entryref object used to reference the deleted header entry.
GET-NODE (handle)
LOGICAL
Returns a handle (handle) to an X-noderef object that references the root node of a DOM tree containing the parsed XML for the underlying SOAP header entry.
GET-SERIALIZED ( )
LONGCHAR
Returns the XML for the underlying SOAP header entry in serialized form.
SET-ACTOR (string)
LOGICAL
(SOAP Version 1.1 only) Sets the value (string) of the actor attribute in the underlying SOAP header entry. With SOAP Version 1.2, use SET-ROLE.
SET-MUST-UNDERSTAND (logical)
LOGICAL
Sets the value (logical) of the mustUnderstand attribute in the underlying SOAP header entry.
SET-NODE (hXnoderef)
LOGICAL
Replaces the header entry referenced by this SOAP header-entryref object with a specified DOM sub-tree (parsed XML) that is assumed to represent a SOAP header entry element. The method performs a deep copy of the XML sub-tree specified by the X-noderef object handle (hXnoderef).
SET-ROLE (string)
LOGICAL
(SOAP Version 1.2 only) Sets the value (string) of the role attribute in the underlying SOAP header entry. With SOAP Version 1.1, use SET-ACTOR.
SET-SERIALIZED (longchar)
LOGICAL
Replaces the header entry referenced by this SOAP header-entryref object with serialized XML (longchar) that is then parsed into a DOM sub-tree that represents a SOAP header entry element. The XML is assumed to be valid for a SOAP header entry.
Note: All of the methods and functions listed in Table 35 return TRUE only if there is an underlying SOAP header entry (XML sub-tree) associated with the object handle.
For more information on these attributes and methods, see OpenEdge Development: ABL Reference.