Adapter requests and responses for the Web Services adapter

The Web Services adapter does not support an action. The samples and templates for the Web Services adapter requests and responses are provided in the following sections.

You can define an adapter request using the following methods:

  • The first method enables you to specify the entire SOAP envelope, thereby enabling complete control to define headers and namespaces. This method supports HTTPS Client Authentication.

  • The second method relies on the adapter to implement SOAP and requires you to specify only the header and body payloads.

  • The third method uses Java API for XML Web Services (JAX-WS) used by Dispatch API for dynamic invocation of service end point operations, by sending data in payload or message mode.

    • In Make SOAP Request Payload mode, you must provide the contents of the <soap-body-content> element and JAX-WS includes the input payload in the <soap:Envelope> element.

    • In Make SOAP Request Message mode, you must provide the entire SOAP envelope. This method supports HTTPS Client Authentication.

    • Poll Asynchronous mode is used when a service operation is invoked asynchronously. The results of the operation are obtained by polling the response.

Note

Starting with the 20.12.02 release, the Web Services adapter requests for method one, method two, and JAX-WS approaches support Internet Protocol version 6 (IPv6) for directing internet traffic and for routing. For details, see Support for IPv6.

You can specify an IPv6 address with a zone ID for the <soap-url> or <host> (whichever applicable) element in the adapter requests—for example, <soap-url>fe80::20c:29ff:fe5d:38f0%eth0</soap-url>
To find the zone ID of the required computer, see Zone ID for an IPv6 address.

A connection is named in the request, and subsequent requests can specify this named connection to be reused for a request. The connection remains available until the endpoint of the process, or until the connection is terminated with a <terminate-on-exit> element. At that point, the connection and any session cookies are flushed from the cache.

Note

For the Web Services adapter, only the method two requests support the named connections feature.

A named connection is defined in an adapter request using a <connection> node containing two child elements, <name> and <terminate-on-exit>. The <name> element is required. The <terminate-on-exit> element is optional and defaults to false, if not defined, maintaining the connection and session cookies. The named connection is an optional function. In the absence of a <connection> node, session cookies do not persist beyond the initial request.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*