Creating a new proxy service configuration using the wsadmin tool

Set the gateway to act purely as a proxy for your service, and use JAX-RPC handlers to set the endpoints for incoming request messages for the service.

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

The wsadmin scripting client is run from Qshell. For more information, see the topic "Configure Qshell to run WebSphere® Application Server scripts".

This command is only valid when used with WebSphere Application Server Version 6 and later application servers. Do not use it with earlier versions.

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

For additional details of the command properties, see the related reference topic.

Purpose

This command creates a new ProxyService object with an associated InboundService object, and a TargetService object with an associated OutboundService object.

You then use a service integration technologies command to add any InboundPort objects that are associated with the InboundService object. For more information, see the worked example at the end of this topic.

Command name
createWSGWProxyService
Target
ObjectName of the gateway instance within which the proxy service is created.
Result
ObjectName of the created ProxyService object.

The command creates the proxy request destination and corresponding reply destination. The proxy request destination is configured to update the reply path to add the proxy 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.

If you specify the name of the proxy request destination, the proxy service destination and port destinations are created with names derived from the proxy request destination name. Otherwise, the proxy service destination and port destinations are created with names derived from the proxy service name. The proxy service destination name is created by adding "ProxyService" to the proxy request destination or proxy service name. Each proxy port destination is then named after the proxy service destination, followed by a colon (":"), followed by the port name, followed by "Port". If a destination with any of these names already exists, the command fails.

Either specify the node and server, or specify the cluster. If there is no messaging engine defined for the specified node and server or cluster, the command fails.

The command creates an OutboundService object, with the same name as the proxy service. This new outbound service uses the created destinations, the supplied localization, and either the default proxy WSDL location for the gateway instance or (if specified) the location of the proxy WSDL file. The new outbound service is associated with the ProxyService object.

The proxy WSDL must have only a single service element. If there are multiple ports within the single service element, an outbound port object is created for each one.

The proxy WSDL should never come from UDDI, so only a Web address is supported for the default and overridden proxy WSDL location.

The command uses the proxy destination to create an InboundService object with the same name as the proxy service, and uses the default or specified proxy WSDL location as the template WSDL location.

Required parameters

name
The proxy service name.

Conditional parameters

node
The node in which the destinations is localized.
server
The server in which the destinations is localized.
cluster
The cluster in which the destinations is localized.

Optional parameters

requestDestination
The name of the proxy request destination.
replyDestination
The name of the proxy reply destination.
wsdlLocation
The location of the proxy WSDL file. This is a Web address.

Example

set proxyService [$AdminTask createWSGWProxyService $wsgw {-name "MyProxyService" -node "MyNode" -server "server1"}]
The following is a minimal example of a sequence of commands to create a fully-functional proxy service with inbound and outbound SOAP over HTTP protocol attachments:
  1. Create the proxy service, where wsgw is the gateway instance:
    set proxyService [$AdminTask createWSGWProxyService $wsgw {-name "ProxyService" -node "MyNode" -server "server1"}]
  2. Get the inbound service for the gateway service, where busName is the name of the service integration bus:
    set inServiceName [$AdminConfig showAttribute $proxyService "inboundServiceName"]
    set inService [$AdminConfig getid /SIBus:$busName/SIBWSInboundService:$inServiceName/]
  3. Add a SOAP over HTTP port, where the SOAP over HTTP 1 endpoint listener is already configured:
    set inPort [$AdminTask addSIBWSInboundPort $inPort {-name "SOAPHTTPPort" -endpointListener "soaphttp1" -node "MyNode" -server "server1"}]
  4. Complete the configuration of the inbound and outbound services and ports. For example, apply JAX-RPC handlers or WS-Security.
Note:
Ensure that all service requesters append an operationMode query string parameter to the address for the proxy service. The value of this parameter is either oneway or requestResponse, and the default is requestResponse. For example:
  • For HTTP operation, if the Web address of the proxy service is
    http://host_name:port_number/wsgwsoaphttp1/soaphttpengine/your_bus/ProxyService/ProxyServiceInboundPort
    then requesting clients indicate that they are sending a one-way request by using the following URL:
    http://host_name:port_number/wsgwsoaphttp1/soaphttpengine/your_bus/ProxyService/ProxyServiceInboundPort?operationMode=oneway
  • For JMS operation, if the JMS address of the proxy service is
    jms:/queue?destination=jndi_queue&connectionFactory=jndi_factory&targetService=your_bus/ProxyService/ProxyServiceInboundPort
    then requesting clients indicate that they are sending a one-way request by using the following URL:
    jms:/queue?destination=jndi_queue&connectionFactory=jndi_factory&targetService=your_bus/ProxyService/ProxyServiceInboundPort&operationMode=oneway



Related concepts
JAX-RPC handlers and proxy operation
Related tasks
Creating a new proxy service configuration
Modifying an existing proxy service configuration
Related reference
Creating a new gateway service configuration using the wsadmin tool
Deleting a gateway service configuration using the wsadmin tool
Adding a target service to a gateway service configuration using the wsadmin tool
Removing a target service from a gateway service configuration using the wsadmin tool
Deleting a proxy service configuration using the wsadmin tool
Deleting a gateway instance using the wsadmin tool
Working with the Web services gateway using the wsadmin tool
Related information
Proxy services [Settings]
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 30, 2013 10:47:11 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-iseries&topic=rwsg_cli_proxy_new
File name: rwsg_cli_proxy_new.html