Deploying Web services to the Web services gateway

 

Before you deploy a Web service to the gateway, deploy the resources (channels, filters, UDDI references and security bindings) that the Web service uses. To deploy a Web service, complete the following steps:

  1. Display the Web services gateway administrative user interface.

  2. In the navigation pane, click:

    Services --> Deploy

  3. Provide values for the following Web service deployment parameters:

    1. Gateway Service Name.

      Type the name by which the Web service will be known within the gateway, and by which it will be listed using the Services > List option. This name must be unique within the gateway and must not contain any spaces.

      If you have several implementations of the same Web service, you can map them all to the same deployed gateway service. You use the Deploy option (this option) to deploy just one instance of a given gateway service. To add more target services to a deployed gateway service, you use the Services > List option.

    2. Message part representation.

      1. Generic classes

        One can select this option in all cases except the following cases:

        • One cannot select this option if your service has EJB or Java bindings that are used at runtime.
        • One cannot select this option if your service uses Vectors, Enumerations, Hashtables or Maps.

      2. Deployed Java classes

        You must select this option if the target services for the gateway service use Vectors, Enumerations, Hashtables or Maps, or contain EJB or Java bindings.

        For Web services deployed with Java bindings (or EJB bindings even where the Web service is on a different server) also make sure that the specific Java classes that have been generated for the Web service are available to the gateway.

        One can also select this option (as an alternative to selecting "Generic classes"):

        • If the target service uses only supported simple and compound types.

        • If the target service uses complex types, and the specific Java classes that have been generated for the Web service are available to the gateway (but note that if you select "Generic classes", then you don't need to also deploy the associated Java classes locally).

    3. Authorization Policy

      Control access to this service. If you want to enable operation-level authorization for this Web service, enable this check box. (Optional)

    4. Audit Policy

      Log requests to this service. (Optional)

      The Audit policy indicates whether the MessageWarehouse object, if present, should be used to log requests and responses for this service. If you have a Message Warehouse implementation, and you want it to log requests and responses for this Web service, enable this check box.

    5. In this release of the gateway, the Annotation URL field is not used.

    6. Select the deployed resources that the Web service is to use, from the following lists:

       

      Channels

      Select one or more deployed channels through which this service is to be available.

       

      Request Filters

      Select zero or more deployed filters to apply to the request.

       

      Response Filters

      Select zero or more deployed filters to apply to the response.

       

      UDDI References

      Select zero or more deployed UDDI references (one for each UDDI registry) that can access the UDDI business category under which you want to publish this service. If you select one or more UDDI references in this step, also enter the UDDI business key in step 3h below.

    7. Specify the Target Service Properties for the Web service:

       

      WSDL Location

      Type the location of the "internal" WSDL file that describes the Web service to be deployed. The WSDL file is either located at a URL, or through a UDDI registry.

      If the WSDL location is a URL, type the URL (if the binding and service definition for this Web service are held in separate WSDL files, then type the URL 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. For example:

        34280367-0ECF-46CE-B804-14C21D6D0FB1 .

      When the Web services 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 URL and is generated and maintained by the Web services gateway itself.

      If the Web service is also published to one or more UDDI registries, then the "internal" WSDL file is required to remove the service from the gateway.

       

      Location Type

      Select the type of location (either URL or UDDI) where the "internal" WSDL file is held.

       

      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's name from the target service WSDL.

       

      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's name from the target service WSDL.

       

      Target Service Identity Information

      Type the identity by which the Web service is known within the Web services gateway. This identity need not be unique.

    8. If you want to publish the service to one or more UDDI registries (selected in a previous step), 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. This is an example of a UDDI business key: 08A536DC-3482-4E18-BFEC-2E2A23630526 .

  4. Click OK.

 

Results

If the processing completes successfully, the list of deployed Web services is updated to include the new Web service. Otherwise, an error message is displayed.

 

What to do next

After deployment, use the list deployed Web services option to change the resources (channels, filters and UDDI references) that the Web service uses, or to add multiple target services for this gateway service.

After deployment, use the list deployed Web services option to change the resources (channels, filters, UDDI references and security bindings) that the Web service uses, or to add multiple target services for this gateway service.

If you enabled the check box 'Authorization Policy - Control access to this service', now enable Web service operation-level authorization.

Data type representation - choosing between Generic classes and Deployed Java classes
Complex data types - mapping namespaces to packages
Working with Web services
List and managing gateway-deployed Web services
Removing Web services from the Web services gateway
Enabling Web Services Security (WS-Security) for the gateway
Configure the gateway security bindings
Editing the service security configuration
Editing the target service security configuration
Web services gateway - Supported types