Adobe ColdFusion 8

Working with WSDL files

WSDL files define the interface to a web service. To consume a web service, you access the service's WSDL file to determine information about it. If you publish your application logic as a web service, you must create a WSDL file for it.

WSDL is a draft standard supported by the World Wide Web Consortium. You can access the specification at www.w3.org/TR/wsdl.

Creating a WSDL file

To publish a web service, you construct the service's functionality and then create the WSDL file defining the service. In ColdFusion, you use components to create web services. ColdFusion automatically generates the WSDL file for a component that you use to produce a web service. For more information on creating web services, see Publishing web services.

For more information on components, see Building and Using ColdFusion Components.

Accessing web services using Dreamweaver

The Dreamweaver Components tab lets you view web services, including operation names, parameter names, and parameter data types.

Open the Components tab in Dreamweaver and add a web service

  1. Select Window > Components, or use Control+F7, to open the Components panel.
  2. In the Components panel, select Web Services from the drop-down list in the upper-left of the panel.
  3. Click the Plus (+) button.

    The Add Using WSDL dialog box appears.

  4. Specify the URL of the WSDL file.

After the web service is defined to Dreamweaver, you can drag it onto a page to call it using the cfinvoke tag.

For more information on using Dreamweaver, see its online Help system.

Note: The Web Services option is not available if you are running Dreamweaver on the Macintosh. However, you can still use web services by writing code manually.

Reading a WSDL file

A WSDL file takes practice to read. You can view the WSDL file in a browser, or you can use a tool such as Dreamweaver, which contains a built-in utility for displaying WSDL files in an easy-to-read format.

The following example shows a WSDL file for the TemperatureService web service: 

<?xml version="1.0"?>
<definitions name="TemperatureService" targetNamespace="http://www.xmethods.net/sd/TemperatureService.wsdl"xmlns:tns="http://www.xmethods.net/sd/TemperatureService.wsdl" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns="http://schemas.xmlsoap.org/wsdl/">
    <message name="getTempRequest">
        <part name="zipcode" type="xsd:string"/>
    </message>
    <message name="getTempResponse">
        <part name="return" type="xsd:float"/>
    </message>
    <portType name="TemperaturePortType">
        <operation name="getTemp">
            <input message="tns:getTempRequest"/>
            <output message="tns:getTempResponse"/>
        </operation>
    </portType>
    <binding name="TemperatureBinding" type="tns:TemperaturePortType">
        <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
        <operation name="getTemp">
            <soap:operation soapAction=""/>
            <input>
                <soap:body use="encoded" namespace="urn:xmethods-Temperature" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
            </input>
            <output>
                <soap:body use="encoded" namespace="urn:xmethods-Temperature" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
            </output>
        </operation>
    </binding>
    <service name="TemperatureService">
        <documentation>Returns current temperature in a given U.S. zipcode</documentation>
        <port name="TemperaturePort" binding="tns:TemperatureBinding">
            <soap:address location="http://services.xmethods.net:80/soap/servlet/rpcrouter"/>
        </port>
    </service>
</definitions>

The following are the major components of the WSDL file:

Component

Definition

definitions

The root element of the WSDL file. This area contains namespace definitions that you use to avoid naming conflicts between multiple web services.

types

(Not shown) Defines data types used by the service's messages.

message

Defines the data transferred by a web service operation, typically the name and data type of input parameters and return values.

port type

Defines one or more operations provided by the web service.

operation

Defines an operation that can be remotely invoked.

input

Specifies an input parameter to the operation using a previously defined message.

output

Specifies the return values from the operation using a previously defined message.

fault

(not shown) Optionally specifies an error message returned from the operation.

binding

Specifies the protocol used to access a web service including SOAP, HTTP GET and POST, and MIME.

service

Defines a group of related operations.

port

Defines an operation and its associated inputs and outputs.

For additional descriptions of the contents of this WSDL file, see Consuming web services.