Package com.ibm.di.fc.webservice

Class AxisEasyInvokeSoapWS

java.lang.Object

com.ibm.di.fc.Function

com.ibm.di.fc.webservice.AxisEasyInvokeSoapWS

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class AxisEasyInvokeSoapWS
extends Function

The Axis EasyInvokeSoapWS Function Component (FC) is part of the TDI Web Services suite. This is a "simplified" web service invocation component: it is a stand-alone FC with its own Config screen, but internally instantiates, configures and uses the following three FCs: AxisJavaToSoap, InvokeSoapWS and AxisSoapToJava. The functionality provided is the same as if you chain and configure these three FCs in an AssemblyLine. When using this FC you lose the possibility to hook custom processing, that is, you are tied to the processing and binding provided by Axis, but you gain simplicity of setup and use. Authentication The AxisEasyInvokeSoapWS FC uses org.apache.axis.client.Call's authentication mechanism. When username and password parameters of the FC are specified, then they are set to be used by the Call object. This information is sent to the server and if it requires authentication it takes this two parameters for username and password.

Field Summary

Fields inherited from class com.ibm.di.fc.Function

logger

Constructor Summary

Constructors

Constructor	Description
AxisEasyInvokeSoapWS()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getVersion()	Version information.
void	initialize(java.lang.Object obj)	Initializes the function component by using the parameters in the Config Tab.
java.lang.Object	perform(java.lang.Object obj)	Provides a relatively simple way of invoking SOAP over HTTP web services.

Methods inherited from class com.ibm.di.fc.Function

debug, getConfiguration, getContext, getDebug, getLog, getParam, getRSInterface, getUI, initialize, logmsg, querySchema, setConfiguration, setContext, setDebug, setLog, setParam, setRSInterface, terminate, updateSchema, verifyInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AxisEasyInvokeSoapWS

public AxisEasyInvokeSoapWS()

Method Detail

initialize

public void initialize(java.lang.Object obj)
                throws java.lang.Exception

Initializes the function component by using the parameters in the Config Tab.

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

obj - not used in this method

Throws:

java.lang.Exception

perform

public java.lang.Object perform(java.lang.Object obj)
                         throws java.lang.Exception

Provides a relatively simple way of invoking SOAP over HTTP web services.

If this FC is passed a Java Object array (Object[]) then it passes to the SOAP operation each Java Object from this array in the order in which the Objects are stored in the array. If this FC is passed an Entry, then the order and values of the parameters passed to the SOAP operation are determined by the value of the "SOAP Operation" FC parameter.

If an Entry is passed to this FC and the SOAP response message returned by the server is not a SOAP Fault message and there is a single output parameter of the "SOAP Operation", then this FC returns the parameter in the "return" Attribute. (Due to Axis 1.1 specifics, if a SOAP operation has a single output parameter, this parameter is considered the return value of the operation. And if a SOAP operation has several output parameters, its return type is considered to be void.)

If an Entry is passed to this FC and the SOAP response message returned by the server is not a SOAP Fault message and there are several output parameters of the SOAP Operation, then this FC returns the output parameters in Entry Attributes, whose names match the names of the SOAP Operation output parameters.

If an Object[] with the input parameters of the SOAP operation is passed to this FC and the SOAP response message returned by the server is not a SOAP Fault message, the result is of type Object[], where the first element is the return value of the SOAP operation (null if the operation is void) and the rest are the output parameters of the operation. Object[] -> AxisEasyInvokeSoapWS FC -> Object[] or Entry -> AxisEasyInvokeSoapWS FC -> Entry

Parameters:

obj -

Returns:

a Java object

Throws:

java.lang.Exception

getVersion

public java.lang.String getVersion()

Version information.

Returns:

version information