Contents

SOAP Notifier COM Objects

SOAP Notifier COM is a set of software components that allow custom applications to invoke handlers. SOAP Notifier COM objects issue SOAP notifications from automation compatible applications. Microsoft's .NET framework makes it possible for programmers to invoke a web service as if they were invoking a method of an object. SOAP Notifier COM components provide a high-performance method of calling handlers without incurring the performance penalty of HTTP-based Listener operations. Third-party applications created using the SOAP Notifier COM components can directly create and forward packets to Interaction Processor, bypassing the need to create packets received using HTTP and the Soap Listener task. These packets that are identical to those created by SOAP ISAPI Listener. However, the process is faster than HTTP-based Listener operations.

SOAP Notifier COM is appropriate for Windows client workstations that can run COM applications. It is not appropriate for operating systems (Linux, for example) that do not support COM. SOAP Notifier COM Components Setup registers SOAP Notifer COM API components on desktop PCs used to develop or run SOAP Notifier COM API applications. Soap_Notifier_COM_API_DG.chm is the SOAP Notifier COM API Developer's Guide. It describes interfaces, methods, and properties of the SOAP Notifier COM API. You will find this publication in the System APIs section of the PureConnect Documentation Library.

ISoapConnector: the MSSOAP Notifier Connector

ProgId: ININ.MSSOAPNotifierConnector

The SOAP Notifier COM API provides a component named ISoapConnector that is used to initiate SOAP handlers. Programmers can invoke a web service as easily as invoking a method on an object. The VB example below shows how to use the transport. It is assumed that a WSDL file with the service description exists, since this is required for MSSOAPLib.SoapClient. Instead of the SoapClient, you may use the MSSOAPLib.SoapSerializer and MSSOAPLib.SoapReader objects with any object that uses a ISoapConnector.

Dim objTransport As New SOAPNotifierCOMLib.SOAPNotifierTransport
objTransport.Connect "<Notifier>", "<AppId>", "<user>", "<password>", "<ClientName>"
Dim objClient As New MSSOAPLib.SoapClient
objClient.ClientProperty("ConnectorProgID") = "ININ.MSSOAPNotifierConnector"
objClient.mssoapinit "<WSDL filename or URL>"
objClient.ConnectorProperty("Transport") = objTransport
Result = objClient.<method>(<arguments>...)

Properties

SOAP Notifier Connector supports the following properties:

Transport: Transport object to be used for server communication. Must be set before the first invocation.
SOAPAction: SOAP Action used in the request. If not defined (empty string), uses value from the WSDL file.
InitiatorEvent: Initator Event (notification event) of the request notification. If not specified or as default, the SOAPAction is used. Changing the SOAPAction also resets this property, unless the PreserveInitiatorEvent property is set. If the SOAPAction has never been set or is an empty string and the value from the WSDL file is used, the InitiatorEvent is reset after each request (again, unless PreserveInitiatorEvent is True).
PreserveInitiatorEvent: If True, changing the SOAPAction does not change the InitiatorEvent property.
RequestTimeout: Maximum amount of time to wait for response in milliseconds. Value < 0 = infinite. Default = 60000 (1 minute).
TransportInfo: Write only. Transport info data. Must be object implementing IStream.
TransportCtrl: Read only. Transport control data, returns IUnknown of an object implementing IStream. Can only be retrieved after invocation until the object using the connector calls the ‘BeginMessage' method of the connector (usually, as part of the next invocation).
ResponseObject: Read Only. Returns the ISOAPResponse object resulting from the request. Can only be retrieved after invocation until the object using the connector calls the ‘BeginMessage' method of the connector (usually, as part of the next invocation).