Creating a Java bean skeleton from a WSDL document using the Apache Axis2 runtime environment

The Web service wizard assists you in creating a skeleton bean from an existing WSDL document. The skeleton bean contains a set of methods that correspond to the operations described in the WSDL document. When the bean is created, each method has a trivial implementation that you replace by editing the bean.

Prerequisites:

  1. You must have installed the Apache Axis2 runtime environment as described in: Creating Web services with the Apache Axis2 runtime environments
  2. If you are using the Apache Jakarta Tomcat servlet container as your server, you must install it, configure an instance of it, and create a Web project targeted to it as described in: Creating an Apache Tomcat server and Web project
  3. Create or import a WSDL file into the Web Content folder of the Web project. You can only use a WSDL file that contains a service element.
To create a Web service from a WSDL file using the Apache Axis2 runtime environment:
  1. Switch to the Java EE perspective (Window > Open Perspective > Java EE).
  2. In the Project Explorer view, select the WSDL file that you created or imported into the Web Content folder of your Web project.
  3. Click File > New > Other. Select Web Services in order to display the various Web service wizards. Select the Web Service wizard. Click Next.
  4. Web Services page: select Top down Java bean Web service as your Web service type, and enter the URI to the WSDL, WSIL, or HTML file that will be used to generate the service.
    1. Select the stages of Web services development that you want to complete using the slider:
      • Develop: this will develop the WSDL definition and implementation of the Web service. This includes such tasks as creating the modules which will contain the generated code, WSDL files, deployment descriptors, and Java™ files when appropriate.
      • Assemble: this ensures the project that will host the Web service or client gets associated to an EAR when required by the target application server.
      • Deploy: this will create the deployment code for the service.
      • Install: this will install and configure the Web module and EARs on the target server.
      • Start: this will start the server once the service has been installed on it. The server-config.wsdd file will be generated.
      • Test: this will provide various options for testing the service, such as using the Web Service Explorer or sample JSPs.
    2. Select your server: the default server is displayed. If you want to deploy your service to a different server click the link to specify a different server.
    3. Select your runtime: ensure the Apache Axis2 runtime is selected.
    4. Select the service project: the project selected in your workspace is displayed. To select a different project click on the project link. If you are deploying to WebSphere® Application Server you will also be asked to select the EAR associated with the project. Ensure that the project selected as the Client Web Project is different from the Service Web Project, or the service will be overwritten by the client's generated artifacts.
    5. If you want to create a client, select the type of proxy to be generated and repeat the above steps for the client.
    6. Publish the Web service: this will launch the Web Services Explorer to publish your Web service to a UDDI registry.
    7. Monitor the Web service: this will send the Web service traffic through the TCP/IP Monitor, which allows you to watch the SOAP traffic generated by the Web service and to test this traffic for WS-I compliance. Alternately you can manually set up a TCP/IP monitor as described in Using the TCP/IP Monitor to test Web services
  5. Axis2 Web Service Skeleton Java Bean Configuration page: Select the folder where the generated Java will be stored. If you want to review or edit the mappings between packages and namespaces, select the Define custom mapping for namespace to package check box. Click Next.
    1. Service Name: accept the default.
    2. Port Name:accept the default.
    3. Databinding Name: Only the Axis2 Databinding Framework (ADB) is supported at this time.
    4. Custom package name: You can change the package name in this field.
    5. Generate an Interface for Skeleton
    6. Generate all types for all elements referred by schemas
    7. Namespace to package mapping: Use this table to review or edit the mappings between packages and namespaces.
  6. Test Web Service page: If you selected to test the Web service, select the test facility for the generated Web service. This will open the Web service in the Web Services Explorer. Select the operation you want to test, enter the required information, and click Go. The result will display in the Status pane. Click Next.
  7. Axis2 Client Web service configuration page: Use this page to select the following options:
    1. Service Name: accept the default.
    2. Port Name: accept the default.
    3. Databinding Name: only the Axis2 Databinding Framework (ADB) is supported at this time.
    4. Custom package name: You can change the package name in this field.
    5. Client mode: You can choose if the client is synchronous, asynchronous, or both.
    6. Generate test case to test the service: If you select this, the Axis2 emitter will generate JUnit testcases matching the WSDL provided to the client. These JUnit testcases will be generated to a newly added source directory to the client project called test.
    7. Generate all types for all elements referred by schemas
    8. Namespace to package mapping: Use this table to review or edit the mappings between packages and namespaces.
  8. Web Service Client Test page: Use this page to select the following options:
    1. Select your test facility. You can test the generated proxy in the Web Service Explorer, or the Universal Test Client.
    2. Select Run test on server to start the server for you automatically.
  9. Web Service Publication page: If you have selected to publish your Web service to a UDDI registry, use this page to launch the Web Services Explorer and select the UDDI registry to which the Web service will be published. Click Finish.
After the Web service has been created, the following may occur depending on the options you selected:
  • If you have selected to test the Web service using the Web Services Explorer, the Explorer will open. Select the operation you want to test, enter the required information, and click Go. The result will display in the Status pane.
  • If you have selected to publish the Web service, the Web Services Explorer is launched displaying the page required to publish your Web service. Follow the instructions in Publishing the Web service to complete this task.