SOAP Class

Properties   Methods   Events   Configuration Settings   Errors  

The SOAP Component is a generic SOAP client supporting SOAP 1.1 that is used to communicate with SOAP servers.

Class Name

IPWorks_SOAP

Procedural Interface

 ipworks_soap_open();
 ipworks_soap_close($res);
 ipworks_soap_register_callback($res, $id, $function);
 ipworks_soap_get_last_error($res);
 ipworks_soap_get_last_error_code($res);
 ipworks_soap_set($res, $id, $index, $value);
 ipworks_soap_get($res, $id, $index);
 ipworks_soap_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_soap_do_addnamespace($res, $prefix, $namespaceuri);
 ipworks_soap_do_addparam($res, $paramname, $paramvalue);
 ipworks_soap_do_attr($res, $attrname);
 ipworks_soap_do_buildpacket($res);
 ipworks_soap_do_config($res, $configurationstring);
 ipworks_soap_do_doevents($res);
 ipworks_soap_do_evalpacket($res);
 ipworks_soap_do_hasxpath($res, $xpath);
 ipworks_soap_do_interrupt($res);
 ipworks_soap_do_reset($res);
 ipworks_soap_do_sendpacket($res);
 ipworks_soap_do_sendrequest($res);
 ipworks_soap_do_value($res, $paramname);

Remarks

The SOAP Class implements a standard SOAP client as specified in the SOAP 1.1 specification.

The class uses HTTP to communicate with SOAP servers, and an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP Method and MethodURI, as well as optional parameters in the Params properties. Then set the target URL and call the SendRequest method.

The results will be provided through the ReturnValue property and the Params properties (for output parameters). Additionally, properties such as XPath, XElement, XText, etc. allow for more granular traversal of the SOAP response.

If the server returns an error, the FaultCode, FaultString, and FaultActor properties will provide information about the error condition.

The class may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important in cases where the underlying SOAP transport is not HTTP, but another mechanism (e.g. SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the class allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.