com.ibm.di.fc.webservice
Class InvokeSoapWS
java.lang.Object
com.ibm.di.fc.Function
com.ibm.di.fc.webservice.InvokeSoapWS
- All Implemented Interfaces:
- FunctionInterface, VersionInfoInterface
public class InvokeSoapWS
- extends Function
The Axis InvokeSoapWS Function Component (FC) is part of the TDI Web Services
suite. It is used to perform a web service call, given the input message for
the call. It has no built-in SOAP parsing functionality and can be used with
the Axis Soap To Java Function Component and Axis Java To Soap Function
Component to provide a complete web service solution. The InvokeSoapWS
Function Component requires a complete SOAP request message. When called with
a SOAP message the Function Component invokes the remote web service
operation with this message. The Function Component returns the SOAP response
message. The Function Component, however, does not perform any XML-Java
binding (that is, the SOAP response message is not parsed) - the Function
Component only returns the SOAP response message.
Method Summary |
String |
getVersion()
Version information. |
void |
initialize(Object obj)
Initializes the function component by using the parameters in the Config
Tab. |
Object |
perform(Object obj)
Makes a web service call by sending a SOAP request message and receiving
a SOAP response message. |
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 |
InvokeSoapWS
public InvokeSoapWS()
initialize
public void initialize(Object obj)
throws 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:
Exception
- if an error occurs.
perform
public Object perform(Object obj)
throws Exception
- Makes a web service call by sending a SOAP request message and receiving
a SOAP response message.
If an Entry was passed to the FC, then if the value of the "Return the
SOAP message as" FC parameter is String then the SOAP response message is
stored in the "xmlString" Attribute; however, If the value of the "Return
the SOAP message as" FC parameter is DOMElement then the SOAP response
message is stored in the "xmlDOMElement" Attribute.
Additionally, if this FC was passed an Entry object, then the FC stores
the SOAP response Header and SOAP response Body (apart from the entire
SOAP response message) as Attributes in the returned Entry. If the value
of the "Return the SOAP message as" FC parameter is String then the SOAP
Header and Body are stored in the "soapHeaderString" and "soapBodyString"
Attributes respectively as java.lang.String objects. If the value of the
"Return the SOAP message as" FC parameter is DOMElement then the SOAP
Header and Body are stored in the "soapHeaderDOMElement" and
"soapBodyDOMElement" Attributes respectively as org.w3c.dom.Element
objects.
If a non-Entry object was passed to this FC, then the return value of the
FC is either a java.lang.String object (when the value of the Return the
SOAP message as FC parameter is String) or an org.w3c.dom.Element object
(when the value is DOMElement).
- Parameters:
obj
-
- Returns:
- a Java object
- Throws:
Exception
getVersion
public String getVersion()
- Version information.
- Returns:
- version information