SOAP WSDL

SOAP WSDL Package

Basic Usage

These chapter describes the basic underlying implementation. It does not require or use the WSDL class generator.

To make a SOAP request as a client, given a WSDL (either as file, string or URL), you have to:

• create a service
• instantiate a client
• create a call object with call arguments
• perform the call
• extract the values from the returned result object

Creating a Service Instance

You need a WSDL to create a service. This can come from multiple sources:

Service from URL (preferred)

this is the preferred method, especially as it wil deal automatically with imported schema definitions (i.e. if the WSDL refers to other documents via an import)

    service := SprayWSDLService onUrl: 'anUrlString'

Service from a String

this only works, if the WSDL is self contained (eg. contains all required definitions and does not import other documents)

    service := SprayWSDLService onXmlString: 'wsdlString'

From a set of Files/Strings

when a WSDL URL is parsed, an transport object instance is used to fetch imported documents. By default, an instance of SptHTTPClient is used to fetch required documents. A mock transport class named SptHTTPLocalTransport can be used. This keeps a list of string documents variable and delivers that contents, when asked for. Thus, if you have a WSDL document, which imports other documents, AND you want to prevent WSDL fetches via http at runtime of you program, you can setup an instance of SptHTTPLocalTransport, give it all the documents (incl. any imported docs), and provide that as a document retriever. For example, if you have a WSDL in (urlA), which imports urlB and urlC, and urlC imports urlD, use the following setup:

    localTransport := SptHTTPLocalTransport new.

    localTransport localDocuments
        at: urlA "eg something like: 'http://foo.services.de:30050/partner/PartnerBusinessService?SCHEMA'"
        put:
'<?xml version="1.0"?> 
... the whole urlA document as string...
'.

   localTransport localDocuments
        at: urlB "eg something like: 'http://foo.services.de..."
        put:
'<?xml version="1.0"?> 
... the whole urlB document as string...
'.

   localTransport localDocuments
        at: urlC "eg something like: 'http://foo.services.de..."
        put:
'<?xml version="1.0"?> 
... the whole urlC document as string...
'.

and create the service with:

    definitions := WSDLDefinitions 
                onUrl: urlA
                transport: localTransport.
    service := SprayWSDLService onDefinitions: definitions.

Then, all required import urls will be fetched from there (eg. no HTTP requests required).

Of course, you can also read the docuemnts from a local file, and setup the localTransport instance from their contents.

---

Copyright © 2014-2024 eXept Software AG