WSGateway command group for the AdminTask object

 

You can use the Jython 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. The WSGateway command group for the AdminTask object includes the following commands:

• addWSGWTargetService

• createWSGWGatewayService

• createWSGWProxyService

• deleteWSGWGatewayService

• deleteWSGWProxyService

• removeWSGWTargetService

 

addWSGWTargetService

The addWSGWTargetService command adds a target to a gateway service. You must specify the targetService parameter or the targetDestination parameter.

Target object Object name of the GatewayService object

Parameters and return values

-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)

Examples

Batch mode example usage:

• Use Jacl:

  set gwTarget [$AdminTask addWSGWTargetService $gwService {-name "AnotherTarget" -targetService "AnotherService"}]
  

• Use Jython string:

  gwTarget=AdminTask.addWSGWTargetService(gwService, '[-name AnotherTarget -targetService AnotherService]')
  

• Use Jython list:

  gwTarget=AdminTask.addWSGWTargetService(gwService, ['-name', 'AnotherTarget', '-targetService', 'AnotherService'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask addWSGWTargetService {-interactive}
  

• Use Jython string:

  AdminTask.addWSGWTargetService ('[-interactive]')
  

• Use Jython list:

  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.

Target object ObjectName of the gateway instance which the gateway service is created

Parameters and return values

-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)

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask createWSGWGatewayService {-interactive}
  

• Use Jython string:

  $AdminTask createWSGWGatewayService ('[-interactive]')
  

• Use Jython list:

  $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.

Target object The object name of the gateway instance within which the proxy service is created.

Parameters and return values

-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)

Examples

Batch mode example usage:

• Use Jacl:

  set proxyService [$AdminTask createWSGWProxyService $wsgw {-name MyProxyService -node MyNode -server server1}]
  

• Use Jython string:

  proxyService = AdminTask.createWSGWProxyService(wsgw, '[-name MyProxyService -node MyNode -server server1]')
  

• Use Jython list:

  proxyService = AdminTask.createWSGWProxyService(wsgw, ['-name', 'MyProxyService', '-node', 'MyNode', '-server', 'server1'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask createWSGWProxyService {-interactive}
  

• Use Jython string:

  AdminTask.createWSGWProxyService ('[-interactive]')
  

• Use Jython list:

  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.

Target object Object name of the gateway service object

Parameters and return values

• Parameters: None

• Returns: None

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteWSGWGatewayService $gwService
  

• Use Jython string:

  AdminTask.deleteWSGWGatewayService(gwService)
  

• Use Jython list:

  AdminTask.deleteWSGWGatewayService(gwService)
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteWSGWGatewayService {-interactive}
  

• Use Jython string:

  AdminTask.deleteWSGWGatewayService ('[-interactive]')
  

• Use Jython list:

  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.

Target object Object name of the ProxyService object

Parameters and return values

• Parameters: None

• Returns: None

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteWSGWProxyService $proxyService
  

• Use Jython string:

  AdminTask.deleteWSGWProxyService(proxyService)
  

• Use Jython list:

  AdminTask.deleteWSGWProxyService(proxyService)
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteWSGWProxyService {-interactive}
  

• Use Jython string:

  AdminTask.deleteWSGWProxyService ('[-interactive]')
  

• Use Jython list:

  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.

Target object The object name of the TargetService object.

Parameters and return values

• Parameters: None

• Returns: None

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask removeWSGWTargetService $gwTarget
  

• Use Jython string:

  AdminTask.removeWSGWTargetService(gwTarget)
  

• Use Jython list:

  AdminTask.removeWSGWTargetService(gwTarget)
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask removeWSGWTargetService {-interactive}
  

• Use Jython string:

  AdminTask.removeWSGWTargetService ('[-interactive]')
  

• Use Jython list:

  AdminTask.removeWSGWTargetService (['-interactive'])
  

---

 

Related tasks

Use the AdminTask object for scripted administration

 

Related Reference

Commands for the AdminTask object

 

Reference topic