Adding Web service deployment information to the deployment descriptor

After you have coded a service part that you want to expose as a Web service, you must add information to the deployment descriptor that tells EGL to generate the necessary Web service wrapper.

Prerequisites

Adding the deployment information

  1. Open the EGL deployment descriptor file and click the Service Deployment tab.
  2. On the Web Service Deployment page, click Add.
  3. In the Add Web Services window, select the Service parts to be exposed as Web services by moving them from the EGL service parts found list to the EGL service parts to be generated as Web services list.
  4. Click Finish. Each service part that you chose is listed in the Services Deployment table.
  5. Select a service part in the list on the left:
    • In the Generate column, indicate whether you want EGL to generate the Web service each time you generate the deployment descriptor; and if so, whether you want the service generated as a SOAP (Web) service, a REST (Web) service, or both. Avoid the overhead of generating the Web service if you are not changing the service part when you generate the deployment descriptor.
    • To access the service logic, double-click an entry in the Implementation column; or highlight the service-binding name and click Open.
    • You can select a HostProgram external type as if it were a Service part. You create that external type for runtime access of an IBM® i program. For more information, see Accessing IBM i programs as Web services
  6. Additional information varies by service type:
    • For a SOAP (Web) service, indicate whether you want to identify the service characteristics with an existing WSDL file. If you check Use Existing WSDL file, you can specify the WSDL file and, within that file, the WSDL service and port elements. If you intend to create the WSDL file later, specify a value in the Style field; select document-wrapped unless the requesters need rpc. If you intend to run the SOAP (Web) service on CICS®, you also may need to specify the access details under Platform-Specific Properties; specifically, the access protocol, as well as the URI used to access the service.
      In the CICS URI field, assign the low-level qualifier for the address used to access the SOAP service. The full address is as follows:
      http://domain:portNumber/URI
      domain
      The domain name; for example, www.example.com.
      portNumber
      The number of the server-machine port that receives the request.
      URI
      The qualifier you are specifying. By default, the value is as follows, where serviceName is the name of the Service part:
      services/serviceName
    • For a REST (Web) service, you can select or clear the Stateful checkbox to indicate whether the service is providing access to a stateful host program on IBM i. The issue is explained in Accessing IBM i programs as Web services.
      Also, in the URI field, assign the low-level qualifier for the address used to access the REST service. The full address is as follows:
      http://domain:portNumber/contextRoot/restservices/URI
      domain
      The domain name; for example, www.example.com.
      portNumber
      The number of the server-machine port that receives the request.
      contextRoot
      A setting in the Web project. The default is the name of the Web project. In relation to WebSphere® Application Server, the value is in the JEE EAR deployment descriptor (application.xml).
      URI
      The qualifier you are specifying.
  7. In the Deployment Targets table, the editor displays all dynamic Web projects that you have configured on the Deployment Targets page of the EGL deployment descriptor. Select the check boxes for the target projects you want to deploy to. Click Configure to go to the Deployment Targets page and add or remove Web projects. The same table appears on the EGL Rich UI Deployment page.
  8. Save the deployment descriptor, which causes an automatic generation of output from that file.

Feedback