Class wwSoap (deprecated)

This class has been deprecated. For an automated way to call Web Services consider using .NET or the West Wind Web Service Proxy Generator

The wwSOAP class provides an easy way to call SOAP based Web Services from Visual FoxPro from Visual FoxPro code using an all Visual FoxPro implementation. It also provides the server side parsing tools so you can create a SOAP Server with any FoxPro based tool with just a few lines of code. In fact the Web Connection wwWebService class that provides the Web Connection Web Service interface does just that.

Athough Microsoft has the MSSOAP toolkit available there are a few issues with this product - namely that can't deal with complex data hardly at all. wwSOAP does a bunch of things that the MS Toolkit does not:

Works on non-WSDL Web Services
Can return typed results
Supports some Complex objects for inbound parameters and outbound results
XML DOM results for all other results
Low level methods that allow custom result parsing for objects/arrays etc.
Provides a SOAP proxy client class
Provides WSDL generation and Proxy Class generation code
Doesn't require the SOAP Toolkit on installations

The real strong points of this class are its ability to create XML from objects to be used for sending in the SOAP packet and turning returned XML back into VFP objects. Even if you do use the SOAP Toolkit the methods of this class can greatly help you in getting your data conversions taken care of much easier.

Dependencies:

The following files are required in order to use wwSOAP in Visual FoxPro* wwUtils.prg

wwHTTP.prg
wwXML.vcx/vct
wconnect.h

Custom wwSoap

Class Members

Member		Description
	AddParameter	Adds a parameter to a SOAP request. Parameters can be passed by FoxPro type or using one of the special names: * Automatic (FoxPro type detection) * * NodeList * Xml * RawXml o.AddParameter(lcName, lvValue,lcXMLType)
	AddReturnValue	Use this method to return more than a single result value to the client before calling [CreateSoapResponseXML](vfps://Topic/wwSoap%3A%3ACreateSoapResponseXML). If you return a single return value you… o.AddReturnValue(lcName, lvValue, lcXMLType)
	CallMethod	Low level SOAP method that is meant to wrap all the SOAP packaging and call mechanism from the client side into a single call. This method's purpose is to make a raw SOAP call using whatever… o.CallMethod(lcMethod, lcUrl, lvResult)
	CallSoapServer	Calls the remote server sends the SOAP request and returns the SOAP response back to the client. This is a lower level method that basically performs the HTTP request. This method deals with the… o.CallSoapServer(lcSOAPRequestXML)
	CallWSDLMethod	Calls a SOAP Server method based on a WSDL description. Call AddParameter for any parameters you need to add to your Methods, then call this method with the name of the method. This method… o.CallWSDLMethod(lcMethod, lvWSDLURL)
	CreateSoapRequestXML	Creates a SOAP request XML package. Calls to this method should be preceeded by by AddParameter() for each parameter to be passed. o.CreateSoapRequestXML(lcMethod)
	CreateObjectXmlFromSchema	Creates Xml from an object with proper case field names based on the WSDL schema definition of the Web Service. This method needs to be used to create object graph XML IF the Web Service uses… o.CreateObjectXmlFromSchema(loObject,lcTypeName,lcFieldName)
	CreateObjectFromSchema	This method allows creation of an empty FoxPro object that matches the properties of the schema definition in the WSDL so that this object can be used to populate values and use it as an input… o.CreateObjectFromSchema(lcWsdlTypeName)
	CreateSoapResponseXML	Creates a SOAP Response XML package from the method name and value o.CreateSoapResponseXML(lcMethod, lvValue, lcResultName)
	GetNamedParameter	Returns a parameter or return value by name. This method must be called after parameter or return value parsing is complete. o.GetNamedParameter(lcParm, llReturnValue)
	ParseSOAPParameters	Retrieves an array for all the parameters in a SOAP Request package. Array format: [1] - Name of the parameter [2] - Value of the parameter [3] - XML type of the parameter (if available) The… o.ParseSOAPParameters(lcRequestXML, @aParameters)
	ParseObject	This method parses an object type into a Fox object if a type definition exists in the WSDL file. This method is used internally by CallWSDLMethod to take object parameters and return generic Fox… o.ParseObject(loObjectNode,lcTypeName)
	ParseObjectArray	Parses a DOM node that contains an array of same type objects into an array. This low level method provides the ability to retrieve XML into a DOM node through the SOAP client and then pass it to… o.ParseObjectArray(@laObjects,lcObjectType,loNodeHeader)
	ParseSoapResponse	Parses the SOAP Response package and returns the result parameter. If datatypes are provided in the SOAP package the value is returned as a typed value, otherwise the value is returned as a string. o.ParseSoapResponse(lcSoapResponse, lvStore)
	ParseObject	This method parses an object type into a Fox object if a type definition exists in the WSDL file. This method is used internally by CallWSDLMethod to take object parameters and return generic Fox… o.ParseObject(loObjectNode, lcTypeName)
	ParseServiceWSDL	Parses a WSDL document file into an object with an easily accessible structure. cInterface - Name of the class cServerUrl - URL that handles this service aMethods[x] - Array of Method… o.ParseServiceWSDL(lcWSDLUrl,llParseTypes)
	SoapErrorResponse	Creates a SOAP error response using fault codes and string. o.SoapErrorResponse(lcError, lnErrorCode)
	aReturnValues	On the client side the array that holds the return values from a method call. On the server side it holds the return values that are to be returned by CreateSoapResponseXML. Client: You can use…
	cExtraEnvelopeAttributes	String value that can be added to the SOAP Envelope root envelope. Useful to add namespace references to the SOAP envelope required by the soap body if you are manually creating parameter or the…
	cErrorMsg	Error Message set when an error occurs in a method call. Check return values from methods or lError for error conditions.
	cMethod	Method to call on the SOAP server.
	cPassword	Basic Authentication password. Not needed unless the SOAP implementation on the server uses Basic Auth internally.
	cRequestXML	Stores the input SOAP XML when a SOAP call is made.
	cResponseXML	Holds the SOAP Response XML in a SOAP call. This result always holds the raw HTTP response from the server.
	cResultName	Name of the return value. By default this value is set to return and shouldn't need changing.
	cMethodNameSpace	Sets the method's namespace prefix. Some SOAP implementations require that the namespace be set for a particular method. Use in conjunction with the cMethodNameSpaceURI property. The default is…
	cMethodNamespaceURI	Sets the method's namespace URI. Some SOAP implementations require that the namespace be set for a particular method. Use in conjunction with the cMethodNameSpace property which sets the prefix. Both…
	cSOAPNameSpace	The namespace reference used for the schema and embedded elements. The default is SOAP which is the same as the MS ROPE client uses (although SOAP-ENV is the spec). On the server in the various…
	cServerUrl	The URL that services the SOAP call.
	cUserName	Basic Authentication username. Not needed unless the SOAP implementation on the server uses Basic Auth internally.
	lError	Error flag set when an error occurs during any method calls. You can check this value after any method call to see if an error occurred.
	lIncludeDataTypes	Determines whether SOAP packages are created with XML data typing (dt: namespace).
	lRecurseObjects	If objects are to be returned this determines whether object properties are hierarchically recursed.
	oHTTP	Use this property to pass in a pre-configured HTTP object to allow you configure the HTTP operation of wwSOAP.
	cHttpProxy	Allows you to specify a proxy server for the SOAP request. Format is in : format.
	nHTTPConnectTimeout	Sets the timeout on the HTTP connection were applicable. Currently only applies if using nHTTPMode = 1 (HTTPGetLight).
	nHTTPConnectType	HTTP Connection type that matches the [wwIPStuff::nHTTPConnectType](vfps://Topic/wwHTTP%3A%3Anhttpconnecttype) property. Applies only when using nHTTPMode of 0 (wwHTTP).
	nReturnMode	Determines how return values are returned 0 - auto (type determined by type attribute or WSDL definition if available. String otherwise) 1 - XML string 2 - XML DOM node used by…
	cSDL	SDL file to use for parameter and return value type information. Only needed when you need typed results from ROPE client. With Web Connection and wwSOAP you can use…
	oSDL	Holds the last SDL file object parsed with the last call to ParseServiceWSDL. The SDL file usage is completely optional and needed only for ROPE based SOAP clients.
	vResult	This value is set on completion of the SOAP request and holds the final result value. If the result value includes data type information the return value is typed.

Assembly: wwSoap.prg