pub.soap.handler:addHeaderBlock

messageContext

Object Message context containing the SOAP message to which to add a header block.

A message context contains properties for the SOAP message and provides access to the SOAP message. Integration Server creates the message context and passes it to the header handler. All handlers invoked by a given instance of a SOAP request or SOAP response use the same message context, which enables you to use the message context to pass information among handlers.

documentType

String Name of the IS document type that specifies the structure and namespaces of the document to use as a new header block.

Specify a document type that Integration Server created while creating the consumer or the WSDL first provider web service descriptor or one that was created using the pub.soap.handler:generateDocumentTypesFromWSDL service.

The QName of the first element in the IS document type is used as the QName of the header block to add to the SOAP message.

The inputHeaderBlock/headerDocument must be a instance of this document type.

inputHeaderBlock

Document Contains information used to create the header block to add to the SOAP message.

Key

Description

mustUnderstand

String Optional. Flag that indicates whether a mustUnderstand attribute is added to the new header block. The mustUnderstand attribute specifies whether recipients (the actor or role at which the header is targeted) are required to process a header entry. Recipients that cannot process a mandatory header entry must reject the message and return a SOAP fault.

Set to:

true to indicate that the attribute mustUnderstand="true" will be added to the header block. This indicates that processing the header entry is required.

false to indicate that the mustUnderstand attribute will not be added to the header block. This indicates that processing the header entry is optional.

There is no default value.

If you do not set mustUnderstand, Integration Server omits the mustUnderstand attribute from the header entry, which is equivalent to setting mustUnderstand to false.

Note:

In SOAP 1.2, the values of the mustUnderstand attribute changed from 0 and 1 to True and False; however, Integration Server processes both sets of values the same and performs any necessary conversions.

role

String Optional. Target of the header entry. The value of role determines the value of the actor or role attribute for the header entry. The actor or role attribute specifies a URI for the recipient of a header entry.

There is no default value. If you do not set role, Integration Server omits the actor attribute from the header entry, which is equivalent to setting role to Ultimate receiver.

For SOAP 1.1, set to:

Ultimate receiver to omit the actor attribute from the header block. This indicates that the recipient is the ultimate destination of the SOAP message.

Next to add an actor attribute with the value "http://schemas.xmlsoap.org/ soap/actor/next" to the header block.

None to add an actor attribute with the value "http://www.w3.org/2003/05/ soap-envelope/role/none" to the header block.

User-specified value to specify the target of the header block. Typically, this will be a URI.

For SOAP 1.2, set to:

Ultimate receiver to omit the role attribute from the header block. This indicates that the recipient is the ultimate destination of the SOAP message.

Next to add a role attribute with the value "http://schemas.xmlsoap.org/ soap-envelope/role/next" to the header block.

None to add a role attribute with the value "http://www.w3.org/2003/05/ soap-envelope/role/none" to the header block.

User-specified value to specify the target of the header block. Typically, this will be a URI.

headerDocument

Document Document to add as a header block. Integration Server converts the document to an XML node and inserts it as a header block.

validate

String Optional. Flag that indicates whether you want the service to validate the inputHeaderBlock/headerDocument document against the IS document type specified in the documentType input parameter. If you do not use documentType to specify an IS document type, the validation will fail.

Set validate to:

true to validate inputHeaderBlock/headerDocument. If the validation fails, an exception is thrown.

false to skip validating inputHeaderBlock/headerDocument. This is the default.