IBM Tivoli Directory Integrator
The WrapSoap Function Component (FC) is part of the TDI Web
Services suite.
Due to limitations of the Axis library used
by this component only WSDL (http://www.w3.org/TR/wsdl)
version 1.1 documents are supported. Furthermore, the supported message
exchange protocol is SOAP 1.1.
This component is used to generate a complete SOAP message given
the SOAP Body and optionally a SOAP Header.
Such a component is useful when the user customizes the content
of the SOAP Body or creates it completely on his own (using Castor
binding for example). This component will accept the contents of the
SOAP Body and the SOAP Header and attributes for the SOAP Envelope, Header and Body XML elements (usually namespace declarations) and
will create the complete SOAP message.
This is actually a helper FC that will save the user from error-prone
processing of string or DOM objects to wrap his SOAP data into a complete
SOAP message.
Parameters
- Input the SOAP Body and Header as
- This drop-down specifies whether the SOAP Body and SOAP Header
input values will be passed as String (that is, java.lang.String)
or as DOM objects (org.w3c.dom.Node).
- Return the SOAP message as
- This drop-down specifies whether the complete SOAP message should
be returned as a String or as a DOM object.
- Header and Body tags present
- Specifies whether the SOAP Body passed in an Attribute contains
the <Body> tag and whether the SOAP Header passed in an Attribute
contains the <Header> tag.
- Attributes to add to the SOAP Envelope
- Specifies the XML attributes and their values to include in
the SOAP Envelope XML element.
- Namespace declarations to add to the SOAP Envelope
- Specifies Namespace declarations to add to the SOAP Envelope.
- Attributes to add to the SOAP Body
- Specifies the XML attributes and their values to include in
the SOAP Body XML element.
- Namespace declarations to add to the SOAP Body
- Specifies Namespace declarations to add to the SOAP Body.
- Attributes to add to the SOAP Header
- Specifies the XML attributes and their values to include in
the SOAP Header XML element.
- Namespace declarations to add to the SOAP Header
- Specifies Namespace declarations to add to the SOAP Header.
- Detailed Log
- Check to generate additional log messages.
- Comment
- Your own comments go here.
Function Component Input
Entry object - it has one Attribute for the SOAP
Header (optional) and one Attribute for the SOAP Body.
If anything else is passed an Exception is thrown.
Function Component Output
An Entry object that contains the complete SOAP message.
The type and format of the entries processed and returned by this
FC are highly dependent on the specified parameters, as clarified
below.
- If the Input the SOAP Body and Header as FC parameter
is String then the SOAP Body is passed in the "soapBodyString"
Attribute and the SOAP Header is passed in the "soapHeaderString"
Attribute. If the Input the SOAP Body and Header as FC parameter
is DOMElement then the SOAP Body is passed in the "soapBodyDOMElement"
Attribute and the SOAP Header is passed in the "soapHeaderDOMElement"
Attribute.
- If the Return the SOAP message as FC parameter is String then
the complete SOAP message is returned in the "xmlString"
Attribute; however if it is specified as DOMElement then
the complete SOAP message is returned in the "xmlDOMElement"
Attribute.
- Each of the Add attributes to... parameters expects
a list of XML attributes to be added to the target SOAP message element
(envelope, header or body) tag in the created SOAP message. Each attribute-value
pair is separated from the other attribute-value pairs by one of the
following symbols: a space, a comma, a semicolon, carriage return
or a line feed. The attribute name in an attribute-value pair is separated
from the attribute value by an equals sign "=".
- Each of the Namespace declarations to add to... parameters
expects a list of XML namespace declarations to be added to the SOAP
message element (envelope, header or body) tag in the created SOAP
message. Each namespace prefix-value pair is separated from the other
namespace prefix-value pairs by one of the following symbols: a space, a comma, a semicolon, carriage return or a line feed. The namespace
prefix in a prefix-value pair is separated from the namespace value
by an equals sign "=".