com.ibm.di.fc.webservice
Class WrapSoap
java.lang.Object
com.ibm.di.fc.Function
com.ibm.di.fc.webservice.WrapSoap
- All Implemented Interfaces:
- FunctionInterface, VersionInfoInterface
public class WrapSoap
- extends Function
The WrapSoap Function Component (FC) is part of the TDI Web Services suite.
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.
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)
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. |
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 |
WrapSoap
public WrapSoap()
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
- 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 Attributes to add... 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: 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: 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
"=".
- Parameters:
obj
- Entry
- Returns:
- the complete SOAP message.
- Throws:
Exception
- if an error occurs.
getVersion
public String getVersion()
- Version information.
- Returns:
- version information