Listing and managing gateway-deployed Web services

Use this task to list the Web services that are deployed to the Web services gateway, and modify their deployment details.

Before you begin

Do not deploy multiple target services to the same gateway service unless you have a filter (or similar mechanism) that can select the required target service, because without filtering the gateway always picks the first target service in the list.

Why and when to perform this task

To list the Web services that are currently deployed to the Web services gateway, and to view and modify their deployment details (including adding or removing multiple target services) complete the following steps:

Steps for this task

  1. Display the Web services gateway administrative user interface.
  2. In the navigation pane, click the following link:

    Services

    • List

    The main pane is updated with a list of all the Web services that are deployed to the Web services gateway.
  3. Click the name of a Web service in the list. A form is displayed that you can use to view and modify the current deployment details for this gateway service, and to add or remove multiple target services.
  4. In the Gateway Service Properties section you can change the following details. When you have finished making changes, click Apply Changes.
    1. Authorization Policy - Control access to this service. Use this check box to enable or disable operation-level authorization for this gateway service.
    2. Audit Policy - Log requests to this service.

      The Audit policy indicates whether the MessageWarehouse object, if present, is used to log requests and responses for this service. If you have a Message Warehouse implementation, use this check box to enable or disable logging of requests and responses for this Web service.

    3. In this release of the gateway, the Annotation URL field is not used.
    4. If you want to publish the service to one or more UDDI registries (selected in the subsequent UDDI References section), enter the UDDI business key in the field provided under UDDI Publication Properties. This key identifies the business category under which you want your service to appear in UDDI. To get a list of valid business keys, look up businesses in a UDDI registry. Here is an example of a UDDI business key: 08A536DC-3482-4E18-BFEC-2E2A23630526. For more information about UDDI business keys, see Publishing a Web service to a UDDI registry for deployment to the gateway.
    5. [Version 5.0.2 and later]If you want to enable or disable Service Security, select or clear the Enable service security check box. If you choose to enable service security, then you must use the Edit service security configuration option to configure secure communication for this gateway service between the service requester (the client) and the gateway. For more information, see Editing the service security configuration.
  5. In the Target Services section you add, modify or remove services from a list of target services for this single gateway service. Every target service on this list provides exactly the same service, and they are presented by the gateway to the service requesters as a single gateway service. To add a new target service, complete the following steps:
    1. WSDL Location and Location Type. Specify the location, and select the location type, for the internal WSDL file that describes the Web service to be deployed. The WSDL file is either located at a Web address, or through a UDDI registry.

      Note:

      • When the gateway deploys the Web service, it generates a matching external WSDL file that it makes available to gateway users. This external WSDL file also describes the service, but is located at a new Web address and is generated and maintained by the Web services gateway.
      • If the service provider makes changes to the internal WSDL file, the gateway does not pick up the changes until the application server on which the gateway is hosted is restarted. For performance reasons, the gateway does not check the service information on each service invocation. The gateway reads the service information when it deploys the Web service, then uses this information for as long as the service remains deployed, or until the application server is restarted.
      • If the Web service is also being published to one or more UDDI registries, then the internal WSDL file is required to remove the service from the gateway.

      If the location for the internal WSDL file is a Web address, type the Web address. If the binding and service definition for this Web service are held in separate WSDL files, then type the Web address of the WSDL file that defines the binding.

      If the WSDL is located through a UDDI registry, type uddiReference,serviceKey where

      • uddiReference is the reference name by which a currently-deployed UDDI reference is known within the gateway, and by which it is listed using the UDDI References > List option.
      • serviceKey is the service key that the UDDI registry has assigned to the service. Here is an example of a UDDI service key: 34280367-0ECF-46CE-B804-14C21D6D0FB1. For more information about UDDI service keys, see Publishing a Web service to a UDDI registry for deployment to the gateway.

    2. Target Service Name. If the Web service WSDL contains more than one service, or the WSDL is located through a UDDI registry, type the target service name from the target service WSDL.
    3. Target Service Namespace. If the Web service WSDL contains more than one service, or the WSDL is located through a UDDI registry, type the namespace of the target service name from the target service WSDL.
    4. Target Service Identity Information. Type the identity by which the target service is known within the Web services gateway. This identity need not be unique.
    5. Click add.
      The target service is added to a list of target services.

    [Version 5.0.2 and later]To modify the deployment details for an existing target service, click on the name of the service in the list of target services. A form is displayed, containing the same fields that you filled in when you added the service, and also the following additional fields:

    • Started. Enable this check box option if you want the gateway to offer this Web service to service requesters.
    • Enable target service security. Enable this check box if you want the gateway to use secure communication between the gateway and the target service.
    • Edit target service security configuration. If you choose to enable target service security, then you must use this option to configure secure communication between the gateway and the target service. For more information see Editing the target service security configuration.

    When you have finished making changes to the target service deployment details, click Apply Changes.

  6. In the Channels section, you can add or remove channels from the list of deployed channels through which this service is available.
  7. In the Request filters section of the gateway service deployment details form, you can add or remove filters from the list of deployed filters that are applied to the service request message.

    Note: The filters are executed in the order shown. To add a filter into the list at a particular position, use the at position menu.

  8. In the Response filters section, you can add or remove filters from the list of deployed filters that are applied to the service response message.

    Note: The filters are executed in the order shown. To add a filter into the list at a particular position, use the at position menu.

  9. In the UDDI References section, you can add or remove UDDI references from the list of deployed UDDI references to UDDI registries in which this service is published. If you select one or more UDDI references in this step, you must also enter a UDDI business key in the field provided under UDDI Publication Properties as described in a previous step. For more information about how the gateway works with UDDI registries, see UDDI registries - Web service directories that integrate with the Web services gateway.
  10. In the Exported WSDL definitions section there are two pairs of WSDL links. Both pairs link to the external WSDL implementation definition, and the external WSDL interface definition.
    • To view the XML source of the associated external WSDL for the service, use the View external WSDL implementation definition links.
    • To return the WSDL parsed for use by application programs that need the WSDL definitions for the service, use the pair labelled External WSDL implementation definition (WSDL only).

    WSDL documents are XML documents, and two pairs of links are supplied in order to display the same external WSDL in two different document formats. The pair of links labelled View external WSDL implementation definition display the XML source for the WSDL, whereas the pair of links labelled External WSDL implementation definition (WSDL only) display the WSDL as it appears in a Web browser.

    For example, in XML notation the ampersand character ("&") is reserved for use in encoding special characters such as the quotation mark ("""). The ampersand character itself is encoded as "&". When you select either of the View external WSDL implementation definition links, you view the literal XML source and the ampersand character is represented as "&". When you select either of the External WSDL implementation definition (WSDL only) links, your Web browser parses the XML source, converts the special characters back into their normal form, and the ampersand character is represented as "&".

    Note: The "&" encoding is required only within the WSDL XML source document. You should not use it in any endpoint address that you supply to a service client. If you get the endpoint address from the WSDL programatically, then the XML parser handles the conversion. If you manually copy and paste the address into the properties file, you should copy the address from one of the External WSDL implementation definition (WSDL only) links.

    If there is an error generating the WSDL then a blank page is returned.

    To help your service users locate the WSDL documents for services that are deployed to the Web services gateway, the gateway also supports the WS-Inspection specification. To open a Web services inspection document that contains references to the WSDL documents for all of the gateway-deployed services, you issue an HTTP GET against

    http://host:port/wsgw/wsinspection.wsil
    where host and port are the host name and port number on which your HTTP server is listening.

    Note: When you use the Web address provided in Testing the installation to list the services that are deployed to the SOAP over HTTP channel, you see a link labeled WSDL next to each service in the list. Do not use these links. To get the WSDL location for your service, open a Web services inspection document.


Related tasks
Working with Web services
Deploying Web services to the Web services gateway
Removing Web services from the Web services gateway
Publishing a Web service to a UDDI registry for deployment to the gateway
Enabling Web Services Security (WS-Security) for the gateway[Version 5.0.2 and later]
Configuring the gateway security bindings[Version 5.0.2 and later]
Editing the service security configuration[Version 5.0.2 and later]
Editing the target service security configuration[Version 5.0.2 and later]



Searchable topic ID:   twsg_admin_listws
Last updated: Jun 21, 2007 4:55:42 PM CDT    WebSphere Application Server Network Deployment, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.websphere.nd.doc/info/ae/ae/twsg_admin_listws.html

Library | Support | Terms of Use | Feedback