IBM® SOAP library reference
The SOAP library primarily consists of the SOAP library, itself, that is used to instantiate the service and the utility functions that you use to convert Web Service Definition Language (WSDL) files into an equivalent .smd description file. In addition, a widget is provided that uses the SOAP library.
SOAP service
SOAP service functions
Function summary | |
---|---|
void | bind (String method, Array parameters, Object deferredRequestHandler, String URL, Object soapParms) Performs the asynchronous communication with the server |
Object | parseResults (Object data) Parses the results received from the server |
Object | generateMethod (String method, Array parameters, String URL, Object soapParms) Generates methods that can be called to invoke the service methods |
void | processSmd (Object object) Processes the service description |
SOAP service function details
bind
- bind (String method, Array parameters, Object deferredRequestHandler, String URL, Object soapParms)
- method : String - Name of the service method to invoke
- parameters : Array - Array of parameters to pass to the service method to be invoked
- deferredRequestHandler : Object - The method that is used to handle the results of the asynchronous call to the server
- url : String - Service endpoint URL
- soapParms : Object - Contains SOAP-specific information that is useful for creating the SOAP envelope
parseResults
- parseResults (Object data)
- data : Object - Name of the service method to invoke
generateMethod
- generateMethod (String method, Array parameters, String URL, Object soapParms)
- method : String - Name of the method to generate
- parameters : Array - Array of parameters to be passed to the service method
- url : String - Service endpoint URL
- soapParms : Object - Contains SOAP-specific information that is useful for creating the SOAP envelope
processSmd
- processSmd (Object object)
- object : Object - Name of the service method to invoke
SOAP service widget
SOAP service widget variables
url | String | Service description URL |
serviceUrl | String | Service endpoint URL |
service | Object | SOAP service object that has the various methods to be invoked |
SOAP service widget functions
Function summary | |
---|---|
void | setUrl(String url) Sets the URL to the service description document |
void | setServiceUrl(String serviceUrl) Sets the URL to the service endpoint |
Object | callMethod(String method, Array parameters) Invokes a service method with the given parameters |
SOAP service widget function details
setUrl
- setUrl(String url)
- url : String - Service description URL
setServiceUrl
- setServiceUrl(String serviceUrl)
- serviceUrl : String - Service endpoint URL
callMethod
- callMethod(String method, Array parameters)
- method : String - Name of the service method to invoke
- parameters : Array - Array of parameters to use for invoking the specified method
WSDL parser
WSDL parser variables
wsdlObj | Object | Service description as a WSDL object |
wsdlString | String | Service description as a WSDL string |
smdObj | Object | Service description as a JSON Object |
smdString | String | Service description as a JavaScriptTM Object Notation (JSON) string |
WSDL parser functions
Function summary | |
---|---|
void | parse(Object obj) Parses the service description from WSDL format to JSON format |
WSDL parser function detailsparse
- parse(Object obj)
- obj : Object - Parameter that contains the WSDL description