Develop a WSDL file

This topic explains how to develop a Web Services Description Language (WSDL) file.

 

Before you begin

Depending on your development path, develop a Service Endpoint Interface for a Java bean implementation or develop a Service Endpoint Interface from an EJB remote interface.

 

Overview

You need a WSDL file to use Web services. We can develop your own WSDL file or get one from a Web services provider through e-mail, downloading, or through a Uniform Resource Locator (URL). This documentation assumes you are creating your own.

Develop a WSDL file by following the actions listed:

 

Procedure

  1. Configure the service endpoint interface class and referenced classes into your CLASSPATH variable.

    • On Windows systems, set CLASSPATH="%CLASSPATH%;<list your application JAR files and classes>".

    • On UNIX and Linux systems, export CLASSPATH="$CLASSPATH:<list your application JAR files and classes>".

  2. Run the Java2WSDL seiInterface command. A WSDL file named seiInterface.wsdl is created.

    • Move the WSDL file to the META-INF/wsdl subdirectory if you are using EJB.

    • Move the WSDL file to the WEB-INF/wsdl subdirectory if you are using JavaBeans.

  3. Edit the generated WSDL file and inspect the part names. The WSDL parts have names like arg_0_0. Modify the WSDL file to use the actual names of the Java parameters.

  4. (Optional) Use the Java2WSDL command tool to generate the correct part names of WSDL file. We can automatically generate and set the correct part names by using the Java2WSDL command tool. Generating and setting the part names is done by providing additional information to the Java2WSDL command tool in the form of a Java implementation class that implements the same methods as the service endpoint interface and is compiled with debug information turned on. Parameter names are stored in the .class file with the debug information. If your implementation class is compiled with debug on, use the Java2WSDL -implClass seiImpl seiInterface command to generate a WSDL file with the proper part names.

 

Result

A WSDL file that defines the Web services described by the service endpoint interface.

 

Example

This example uses the JAR file name AddressBook.jar that contains a class named AddressBook.class class file.

You must add the AddressBook.jar file to your CLASSPATH to create the WSDL file. The JAR file contains an EJB implementation class that is compiled with debugging information turned on. Run the Java2WSDL -implClass addr.AddressBookBean addr.AddressBook command to create the file, AddressBook.wsdl.

 

What to do next

Depending on your development path, develop Web services deployment descriptor templates for a Java bean implementation or develop Web services deployment descriptor templates for an EJB implementation.

 

See Also


WSDL

 

Related Tasks


Developing a new Web service with an existing WSDL file using JavaBeans technology
Developing new Web services from an existing WSDL file using an EJB implementation
Developing a Web service from an enterprise bean
Publishing WSDL files

 

See Also


WSDL architecture
Multipart WSDL best practices
Artifacts used to develop Web services
Java2WSDL command