Axis Soap To Java Function Component

IBM Tivoli Directory Integrator

Axis Soap To Java Function Component

The Axis Soap-to-Java 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 can be used both on the web service client and on the web service server side. This FC uses Axis' mechanism for parsing SOAP response (when on the client) or SOAP request (when on the server) to Java objects - as a complementary component to the AxisJavaToSoap FC. It is given a SOAP response/request message and returns the parsed Java objects either as standalone Java object(s) or capsulated in an Entry object.

This component supports both RPC and Document style.

Configuration

Parameters

WSDL URL: The URL of the WSDL document describing the service
SOAP Operation: The name of the SOAP operation as described in the WSDL file
Input the SOAP message as: This drop-down list specifies whether the SOAP message is specified as a string or as a DOM object.
Complex Types: This parameter is optional; if specified, it should be a list of fully qualified Java class names (including the package name), where the different elements (Java classes) of this list are separated by one or more of the following symbols: a comma, a semicolon, a space, a carriage return or a new line.
Mode: This required parameter takes either a value of Request or Response. The value of Specifies whether this FC will parse SOAP request or SOAP response messages.
Detailed Log: If checked, will generate additional log messages.
Comment: Your own comments go here.

Function Component Input

Entry or Java Object representing the complete SOAP message.

If anything else is passed, an Exception is thrown.

Function Component Output

An Entry or a Java Object containing the Java representation of the SOAP request/response.

Using the FC

This Function Component parses a SOAP message and turns it into a Java Object.

If this FC is passed a SOAP Fault message to parse, this FC returns a Java object of type org.apache.axis.AxisFault.
In case this FC returns an org.apache.axis.AxisFault object, the FC stores this object in the "soapFault" Attribute if an Entry is passed to the FC; and if a java.lang.Object was passed then this FC returns the org.apache.axis.AxisFault object.
If the value of the Input the SOAP message as FC parameter is String then the SOAP message to parse is read from the "xmlString" Attribute as a java.lang.String, provided an Entry is passed to the FC. If the value of the Input the SOAP message as FC parameter is DOMElement then the SOAP message to parse is read from the "xmlDOMElement" Attribute as an org.w3c.dom.Element object, provided an Entry is passed to the FC.
If a Java Object is passed to this FC, then the SOAP message to parse is assumed to be the value of the passed Java Object as either a java.lang.String object (when the value of the Input the SOAP message as" FC parameter is String) or as an org.w3c.dom.Element object (when the value of the Input the SOAP message as FC parameter is DOMElement).
This FC is capable of parsing (a) Document style SOAP messages, (b) RPC style SOAP messages and (c) SOAP Fault messages.
This FC is capable of parsing SOAP messages encoded using both "literal" encoding and SOAP Section 5 encoding.
This FC is capable of parsing SOAP messages containing values of complex types which are defined in the <types> section of a WSDL document. In order to do that this FC requires that (1) the Complex Types FC parameter contains the names all Java classes that implement the complex types used in the SOAP message and (2) these Java classes' class files are located in the Java class path of TDI.
If an Entry is passed to this FC and the message parsed is not a SOAP Fault message, then this FC returns the output parameters in Entry Attributes, whose names match the names of the SOAP Operation output parameters.