Commands for the WSGateway group of the AdminTask object
Use the Jython (recommended) or Jacl scripting languages to manage deployed applications with the wsadmin tool. The commands and parameters in the WSGateway group can be used to create and manage gateway services, proxy services, and target services.
For more information about the AdminTask object, see the Commands for the AdminTask object article.
The following commands are available for the WSGateway group of the AdminTask object:
addWSGWTargetService
The addWSGWTargetService command adds a target to a gateway service. You must specify the targetService parameter or the targetDestination parameter.
Object name of the GatewayService object
- Parameters:
- name
- The administrative name of the target service. (Required)
- targetDestination
- The name of the target destination. This can be within the same bus as the gateway destination or in a different bus. If the target destination is not within the same bus as the gateway destination, also specify the targetBus parameter. You must either specify the targetDestination parameter or the targetService parameter. (Conditional)
- targetService
- The name of the target outbound service. You must either specify the targetDestination parameter or the targetService parameter. (Conditional)
- targetBus
- The name of the WPM bus that contains the target. (Optional)
- Returns: The object name of the target service object that you created.
Batch mode example usage:
Using Jacl
set gwTarget [$AdminTask addWSGWTargetService $gwService {-name "AnotherTarget" -targetService "AnotherService"}]Using Jython string
gwTarget=AdminTask.addWSGWTargetService(gwService, '[-name AnotherTarget -targetService AnotherService]')
Interactive mode example usage:
Using Jacl
$AdminTask addWSGWTargetService {-interactive}Using Jython string
AdminTask.addWSGWTargetService ('[-interactive]')
createWSGWGatewayService
The createWSGWGatewayService command creates a new GatewayService with associated InboundService and TargetService objects. Configuration of the InboundPort and OutboundService/Port that is associated with these objects is done using separate commands.
ObjectName of the gateway instance which the gateway service is created
- Parameters:
- -name
- Administrative name of the Gateway Service. (required)
- -wsdlLocation
- Location of the template WSDL. May be a URL or a UDDI business key (UUID). (conditional)
- -wsdlServiceName
- The name of the service in the WSDL. (conditional)
- -wsdlServiceNamespace
- The namespace of the service in the WSDL. (conditional)
- -targetDestination
- The name of the target destination. (conditional)
- -targetService
- The name of the target outbound service. (conditional)
- -requestDestination
- The name of the gateway destination. (optional)
- -replyDestination
- The name of the gateway reply destination. (optional)
- -targetBus
- The name of the WPM bus containing the target. (optional)
- -uddiReference
- The reference of the UDDI registry for the WSDL. (optional)
- -userId
- The user id to use to retrieve the WSDL. (optional)
- -password
- The password to use to retrieve the WSDL. (optional)
- Returns: ObjectName of the created GatewayService object
Batch mode example usage:
Using Jacl
set gwService [$AdminTask createWSGWGatewayService $wsgw {-name MyGatewayService -targetService MyService}]Using Jython string
gwService = AdminTask.createWSGWGatewayService(wsgw, '[-name MyGatewayService -targetService MyService]')
Interactive mode example usage:
Using Jacl
$AdminTask createWSGWGatewayService {-interactive}Using Jython string
$AdminTask createWSGWGatewayService ('[-interactive]')
createWSGWProxyService
The createWSGWProxyService command creates a new proxy service with an associated inbound service and a target service object with an associated outbound service. Configuration of the inbound port objects that are associated with the inbound service is done using separate commands.
The object name of the gateway instance within which the proxy service is created.
- Parameters:
- name
- The administrative name of the proxy service. (required)
- node
- The node where the destinations will be localized. (conditional)
- server
- The server where the destinations will be localized. (conditional)
- cluster
- Cluster where the destinations will be localized. (conditional)
- -requestDestination
- The name of the proxy request destination. (optional)
- -replyDestination
- The name of the proxy reply destination. (optional)
- -wsdlLocation
- The location of the proxy WSDL (URL). (optional)
- Returns: The object name of the proxy service object that you created.
Batch mode example usage:
Using Jacl
set proxyService [$AdminTask createWSGWProxyService $wsgw {-name MyProxyService -node MyNode -server server1}]Using Jython string
proxyService = AdminTask.createWSGWProxyService(wsgw, '[-name MyProxyService -node MyNode -server server1]')
Interactive mode example usage:
Using Jacl
$AdminTask createWSGWProxyService {-interactive}Using Jython string
AdminTask.createWSGWProxyService ('[-interactive]')
deleteWSGWGatewayService
The deleteWSGWGatewayService command deletes a gateway service. It deletes the gateway destination, the corresponding reply destination, the inbound service, the inbound port enablement objects, and all of the associated target service objects. This command does not delete the destinations that are associated with the target services.
Object name of the gateway service object
- Parameters: None
- Returns: None
Batch mode example usage:
Using Jacl
$AdminTask deleteWSGWGatewayService $gwServiceUsing Jython string
AdminTask.deleteWSGWGatewayService(gwService)
Interactive mode example usage:
Using Jacl
$AdminTask deleteWSGWGatewayService {-interactive}Using Jython string
AdminTask.deleteWSGWGatewayService ('[-interactive]')
deleteWSGWProxyService
The deleteWSGWProxyService command deletes a proxy service that includes the proxy destinations, outbound service, outbound ports, inbound service, and inbound port enablement objects.
Object name of the ProxyService object
- Parameters: None
- Returns: None
Batch mode example usage:
Using Jacl
$AdminTask deleteWSGWProxyService $proxyServiceUsing Jython string
AdminTask.deleteWSGWProxyService(proxyService)
Interactive mode example usage:
Using Jacl
$AdminTask deleteWSGWProxyService {-interactive}Using Jython string
AdminTask.deleteWSGWProxyService ('[-interactive]')
removeWSGWTargetService
The removeWSGWTargetService command removes a target service from the gateway service. The destinations that are associated with the target service are not deleted. If the target service that you remove is the default target service, the default is set to the first target service in the set or cleared if none are left.
The object name of the TargetService object.
- Parameters: None
- Returns: None
Batch mode example usage:
Using Jacl
$AdminTask removeWSGWTargetService $gwTargetUsing Jython string
AdminTask.removeWSGWTargetService(gwTarget)
Interactive mode example usage:
Using Jacl
$AdminTask removeWSGWTargetService {-interactive}Using Jython string
AdminTask.removeWSGWTargetService ('[-interactive]')
Related tasks
Using the AdminTask object for scripted administration Related reference
Commands for the AdminTask object