Develop a WSDL file

 

Overview

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 Web Services Description Language (WSDL) file to use Web services. You can develop your own WSDL file or get one from a Web service provider through E-mail, downloading or through a Uniform Resource Locator (URL). This documentation assumes you are creating your own.

To develop a WSDL file:

  1. Configure the Service Endpoint Interface class and referenced classes into your CLASSPATH.

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

    • On UNIX, 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 an enterprise JavaBean (EJB).

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

  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.You 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 on (javac -g). Parameter names are stored in the .class file with the debug information. If your implementation class was compiled with debug on, you can use the Java2WSDL -implClass seiImpl seiInterface command to generate a WSDL file having the proper part names.

 

Results

A WSDL file that defines the Web service described by the Service Endpoint Interface.

 

Example

This example uses a JAR file named AddressBook.jar containing a class named AddressBook.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 was compiled with debugging information on. Run the Java2WSDL -implClass addr.AddressBookBean addr.AddressBook command to create a WSDL file named 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.


Related concepts
WSDL
Related tasks
Developing a new Web service with an existing WSDL file using a Java bean
Developing a new Web service from an existing WSDL file using a stateless session enterprise bean
Developing a Web service from an enterprise bean
Related reference
WSDL architecture
Multipart WSDL best practices
Artifacts used to develop Web services based on Web Services for J2EE
Artifacts used to develop Web services based on Web Services for J2EE
Java2WSDL command