createWSGWGatewayService command
Use the createWSGWGatewayService command to create a new gateway service configuration.
You can create a new gateway service configuration by using the wsadmin tool as described in this topic, or by using the administrative console as described in Creating a new gateway service configuration.
To run the command, use the AdminTask object of the wsadmin scripting client.
The wsadmin scripting client is run from Qshell.
- For a list of the available gateway commands, plus a brief description of each
command, enter the following command at the wsadmin prompt:
print AdminTask.help('WSGateway')
- For overview help on a given command, enter the following command at the wsadmin
prompt:
print AdminTask.help('command_name')
After using the command, save your changes to the master configuration by using the following command:
Before you use this command, you might want to use service integration bus-enabled web services commands to create a new outbound service and add an outbound port. For more information, see the worked example at the end of this topic.
Purpose
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 you 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:
The service-specific part of this key is the final part:uddi:blade108node01cell:blade108node01:server1:default:6e3d106e-5394-44e3-be17-aca728ac1791
6e3d106e-5394-44e3-be17-aca728ac1791
- -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).
- -targetBus
- The name of the service integration bus that hosts the target destination.
- -targetService
- The name of the target outbound service.
Optional parameters
- -requestDestination
- The name of the gateway request destination.
- -replyDestination
- The name of the gateway reply destination.
- -uddiReference
- If you specified a UDDI service key as the WSDL location, supply the UDDI reference for the target UDDI registry.
- -userId
- The user ID that you use to retrieve the WSDL.
- -password
- The password that you use to retrieve the WSDL.
Example
- Using
Jython:
gwService = AdminTask.createWSGWGatewayService(wsgw, ["-name", "MyGatewayService", "-targetService", "MyService"])
- Using
Jacl:
set gwService [$AdminTask createWSGWGatewayService $wsgw {-name "MyGatewayService" -targetService "MyService"}]
- Create the outbound service that represents the service provider, where bus
is the service integration bus:
- Using
Jython:
outService = AdminTask.createSIBWSOutboundService(bus, ["-name", "StockQuoteService", "-wsdlLocation", "http://myserver.com/wsdl/StockQuoteService.wsdl"])
- Using
Jacl:
set outService [$AdminTask createSIBWSOutboundService $bus {-name "StockQuoteService" -wsdlLocation "http://myserver.com/wsdl/StockQuoteService.wsdl"}]
- Using
Jython:
- Add a SOAP over HTTP port as defined in the service provider WSDL:
- Using
Jython:
outPort = AdminTask.addSIBWSOutboundPort(outService, ["-name", "SOAPHTTPPort", "-node", "MyNode", "-server", "server1"])
- Using
Jacl:
set outPort [$AdminTask addSIBWSOutboundPort $outService {-name "SOAPHTTPPort" -node "MyNode" -server "server1"}]
- Using
Jython:
- Create the gateway service, where wsgw is the gateway instance:
- Using
Jython:
gwService = AdminTask.createWSGWGatewayService(wsgw, ["-name", "StockQuoteGatewayService", "-targetService", "StockQuoteService"])
- Using
Jacl:
set gwService [$AdminTask createWSGWGatewayService $wsgw {-name "StockQuoteGatewayService" -targetService "StockQuoteService"}]
- Using
Jython:
- Get the inbound service for the gateway service, where busName is the name of
the service integration bus:
- Using
Jython:
inServiceName = AdminConfig.showAttribute(gwService, "inboundServiceName")
inService = AdminConfig.getid( "/SIBus:"+busName+"/SIBWSInboundService:"+inServiceName+"/" )
- Using
Jacl:
set inServiceName [$AdminConfig showAttribute $gwService "inboundServiceName"]
set inService [$AdminConfig getid /SIBus:$busName/SIBWSInboundService:$inServiceName/]
- Using
Jython:
- Add a SOAP over HTTP port, where the SOAP over HTTP 1 endpoint listener is already configured:
- Using
Jython:
inPort = AdminTask.addSIBWSInboundPort(inPort, ["-name", "SOAPHTTPPort", "-endpointListener", "soaphttp1", "-node", "MyNode", "-server", "server1"])
- Using
Jacl:
set inPort [$AdminTask addSIBWSInboundPort $inPort {-name "SOAPHTTPPort" -endpointListener "soaphttp1" -node "MyNode" -server "server1"}]
- Using
Jython:
- Complete the configuration of the inbound and outbound services and ports. For example, apply JAX-RPC handlers or WS-Security.