createWSGWGatewayService command

Use the createWSGWGatewayService command to create a new gateway service configuration.

Create a new gateway service configuration using wsadmin.sh, or using the administrative console as described in Create a new gateway service configuration.

To run the command, use the AdminTask object of the wsadmin scripting client.

(iSeries) (iSeries) The wsadmin scripting client is run from Qshell. (iSeries) See Configure Qshell to run WebSphere scripts .

Command-line help is provided for service integration bus commands:

• For a list of the available gateway commands, plus a brief description of each command, enter at the wsadmin prompt:

  print AdminTask.help('WSGateway')

• For overview help on a given command, enter at the wsadmin prompt:

  print AdminTask.help('command_name')

After using the command, save the changes to the master configuration using the following command:

AdminConfig.save()

Before we use this command, we might want to use service integration bus-enabled web services commands to create a new outbound service and add an outbound port. See worked example at the end of this topic.

This command creates a new GatewayService with associated InboundService and TargetService objects.

Target object

ObjectName of the gateway instance within which the gateway service is created.

The command creates the gateway request destination and corresponding reply destination. The gateway request destination is configured to update the reply path to add the reply destination. If a destination with the specified or default names already exists, the command fails.

If a gateway service or proxy service with the same name already exists, the command fails.

The command always creates an InboundService object with the same name as the gateway service. The command fails if an inbound service with that name already exists.

The WSDL location from the OutboundService object or specified on the command is used as the template WSDL location for the inbound service. If the WSDL is to be retrieved through a proxy, the server on which the command is running must have the system properties that identify the proxy server set correctly. If the proxy requires authentication, then the user ID and password can be set as parameters on the command.

The TargetService object created by this command is set as the default for the gateway service, and the default forward routing path on the gateway destination is set to point at the target destination. The gateway destination com.ibm.websphere.wsgw.targets property is set to contain the target destination or destination associated with the outbound service. The com.ibm.websphere.wsgw.gatewayService and com.ibm.websphere.wsgw.gatewayInstance properties on the gateway destination are set appropriately.

Required parameters

-name

The gateway service name.

Conditional parameters

-wsdlLocation

The location of the template WSDL file.

This is either a web address or the service-specific part of a UDDI service key. If we specify a UDDI reference, the WSDL location is assumed to be a UDDI service key.

Here is an example of a full UDDI service key:

uddi:blade108node01cell:blade108node01:server1:default:6e3d106e-5394-44e3-be17-aca728ac1791

The service-specific part of this key is the final part:

6e3d106e-5394-44e3-be17-aca728ac1791

If not specified, then the WSDL location from the OutboundService object is used as the template WSDL location.

-wsdlServiceName

The name of the service within the WSDL. Only required if the template WSDL contains more than one service, or the WSDL is located through a UDDI registry.

-wsdlServiceNamespace

The namespace of the service within the WSDL. Only required if the template WSDL contains more than one service, or the WSDL is located through a UDDI registry, or the service is not in the default namespace for the WSDL document.

-targetDestination

The name of the target destination, which might be within the same service integration bus as the gateway destination or in another bus (in which case the -targetBus must also be specified).

Specify either the -targetDestination or the -targetService parameter.

-targetBus

The name of the service integration bus that hosts the target destination.

Specify this parameter if the -targetDestination parameter has been specified and the target destination is not within the same service integration bus as the gateway destination.

-targetService

The name of the target outbound service.

Specify either the -targetDestination or the -targetService parameter.

Optional parameters

-requestDestination

The name of the gateway request destination.

-replyDestination

The name of the gateway reply destination.

-uddiReference

If we specified a UDDI service key as the WSDL location, supply the UDDI reference for the target UDDI registry.

-userId

The user ID that we use to retrieve the WSDL.

-password

The password used to retrieve the WSDL.

Example

• Use Jython:

  gwService = AdminTask.createWSGWGatewayService(wsgw, ["-name",
   "MyGatewayService", "-targetService", "MyService"])
  

• Use Jacl:

  set gwService [$AdminTask createWSGWGatewayService $wsgw {-name 
  "MyGatewayService" -targetService "MyService"}]
  

The following is a minimal example of a sequence of commands to create a fully-functional gateway service with inbound and outbound SOAP over HTTP protocol attachments:

1. Create the outbound service that represents the service provider, where bus is the service integration bus:

   • Use Jython:

     outService = AdminTask.createSIBWSOutboundService(bus, ["-name",
      "StockQuoteService",
      "-wsdlLocation", "http://myserver.com/wsdl/StockQuoteService.wsdl"])
     

   • Use Jacl:

     set outService [$AdminTask createSIBWSOutboundService $bus {-name 
     "StockQuoteService"
      -wsdlLocation "http://myserver.com/wsdl/StockQuoteService.wsdl"}]
     

2. Add a SOAP over HTTP port as defined in the service provider WSDL:

   • Use Jython:

     outPort = AdminTask.addSIBWSOutboundPort(outService, ["-name", "SOAPHTTPPort",
      "-node", "MyNode", "-server", "server1"])
     

   • Use Jacl:

     set outPort [$AdminTask addSIBWSOutboundPort $outService {-name "SOAPHTTPPort"
      -node "MyNode" -server "server1"}]
     

3. Create the gateway service, where wsgw is the gateway instance:

   • Use Jython:

     gwService = AdminTask.createWSGWGatewayService(wsgw, ["-name",
      "StockQuoteGatewayService", "-targetService", "StockQuoteService"])
     

   • Use Jacl:

     set gwService [$AdminTask createWSGWGatewayService $wsgw {-name
      "StockQuoteGatewayService" -targetService "StockQuoteService"}]
     

4. Get the inbound service for the gateway service, where busName is the name of the service integration bus:

   • Use Jython:

     inServiceName = AdminConfig.showAttribute(gwService, "inboundServiceName")
     

     inService = AdminConfig.getid(
      "/SIBus:"+busName+"/SIBWSInboundService:"+inServiceName+"/" )
     

   • Use Jacl:

     set inServiceName [$AdminConfig showAttribute $gwService "inboundServiceName"]
     

     set inService [$AdminConfig getid 
     /SIBus:$busName/SIBWSInboundService:$inServiceName/]
     

5. Add a SOAP over HTTP port, where the SOAP over HTTP 1 endpoint listener is already configured:

   • Use Jython:

     inPort = AdminTask.addSIBWSInboundPort(inPort, ["-name", "SOAPHTTPPort",
      "-endpointListener", "soaphttp1", "-node", "MyNode", "-server", "server1"])
     

   • Use Jacl:

     set inPort [$AdminTask addSIBWSInboundPort $inPort {-name "SOAPHTTPPort"
      -endpointListener "soaphttp1" -node "MyNode" -server "server1"}]
     

6. Complete the configuration of the inbound and outbound services and ports. For example, apply JAX-RPC handlers or WS-Security.