Start of change
WebSphere Message Brokers
File: ac56210_.dita
Writer: Kate Hostler

Reference topic

This build: July 31, 2007 21:21:29

SOAPAsyncResponse node

This topic describes the SOAPAsyncResponse node.

Purpose

Use the SOAPAsyncResponse node in conjunction with the SOAPAsyncRequest node to construct a pair of message flows that start a Web service asynchronously. The SOAPAsyncRequest node sends a Web service request, but the node does not wait for the associated Web service response to be received (the message flow is not blocked at this point

Draft comment:
when is it blocked? why is it blocked?
). The Web service response is received by the SOAPAsyncResponse node, which is in a separate message flow. The nodes are used as a pair, and correlate responses against the original requests.

The SOAPAsyncResponse node is the second half of the asynchronous request and response node pair. The SOAP role for this node is set to RespondingSOAPNode. SOAP fault messages are directed to the Fault terminal, all of the other exceptions are directed to the Failure terminal. The SOAPAsyncResponse node is an input node because it starts a flow and it has a Catch terminal. The SOAPAsyncResponse node processes only messages that are initiated by the corresponding SOAPAsyncRequest node. Therefore, the SOAPAsyncResponse node expects to receive SOAP response messages or SOAP fault messages rather than SOAP request messages. The SOAPAsyncResponse node enforces this in either of the following two ways:
  • For HTTP, the URL on which the node is listening is unique to this node.
  • When the node receives a message it checks that the message contains the correct SOAP Headers, such as the user context information (with the isReferenceParameter attribute set) sent by the corresponding SOAPAsyncRequest node.

When the SOAPAsyncResponse node is satisfied that the message is correctly targeted, the node copies the user context information to the LocalEnvironment and propagates the message from the node.

Draft comment:
Which node?

The SOAPAsyncResponse node is contained in the Web Services drawer of the palette, and is represented in the workbench by the following icon:

SOAPAsyncResponse node icon

Using this node in a message flow

Look at the following sample to see how to use this node:
  • SOAP sample
*!ENTITY!**!ENTITY!*LINK TO SOAP SAMPLE>>

You can view samples only when you use the information center that is integrated with the Message Brokers Toolkit.

Configuring the SOAPAsyncResponse node

When you have put an instance of the SOAPAsyncResponse node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.

All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.

Configuration of the SOAPAsyncResponse node is not WSDL-driven, although the Must understand headers property configured on the corresponding SOAPAsyncRequest node is applicable to the SOAPAsyncResponse node.

  1. Optional: On the Description tab, enter a short description, a long description, or both. You can also rename the node on this tab.
  2. On the Basic tab you must specify the following property:
    • Correlation ID. You must specify the unique URL fragment that is common to your pair of SOAPAsyncRequest and SOAPAsyncResponse nodes.
      Draft comment:
      Toolkit says : "specify unique URL fragment common for a pair of asynchronous request/response nodes". Feature doc says "Enter the name of the of the corresponding asynchronous request node." Which is right?
  3. On the Advanced tab, you can specify the following properties:
    • Set destination list. This property is automatically selected.
    • Label prefix. Enter a prefix if required.
    Draft comment:
    Request info - nothing in the Feature doc info so far taken from Toolkit
  4. On the Administration tab, you can specify the following properties:
    • Component level. This property has the following values:
      • Node.
      • Flow. The default.
    • Additional instances. This property has the default value 0.
    Draft comment:
    Request info - nothing in the Feature doc, info so far taken from Toolkit
  5. On the Response Message Parsing tab, set the values for the properties that the node uses to determine how to parse the incoming message. This tab has the following properties:
    • Message domain. This property has the default value SOAP.
    • Message set. This property must have a value. The Message set property enables you to select any message set that supports the SOAP domain.
    Draft comment:
    Same as SOAPRequest node
  6. On the Parser options sub-tab, you can set the values for the following properties:
    Draft comment:
    Similar to SOAPRequest node + message set. (but Message set is on Response Message Parsing tab!)
    • Parse timing. The valid values for this property are:
      • Immediate.
      • On Demand. The default.
      • Complete.
    • Build tree using XML schema data types. Select this check box if you want to use this option.
    • Retain mixed content. Select this check box if you want to use this option.
    • Retain comments. Select this check box if you want to use this option.
    • Retain processing instructions. Select this check box if you want to use this option.
    • Opaque elements. This property contains an elements table. You can Add, Edit and Delete in this table.
  7. On the Validation tab, you can set the values for the following properties:
    Draft comment:
    Same as SOAPRequest node
    • Validate. The valid values for this property are:
      • None.
      • Content and value. The default.
      • Content.
    • Failure action. The valid values for this property are:
      • User trace.
      • Exception list.
      • Local error log.
      • Exception. The default.

Terminals and properties

The SOAPAsyncResponse node terminals are described in the following table.

Terminal Description
Failure The output terminal to which a message is routed if a failure is detected when the message is propagated to the Out flow (such as a message validation failure). Failures routed to this terminal include those caused by the retry processing occurring before the retry propagates the message to the Out flow.
Out The output terminal to which the message is routed if it has been successfully put to the output queue, and if further processing is required within this message flow. If no errors occur within the input node, a message received from an external resource is always sent to the Out terminal first.
Fault SOAP fault messages will be directed down the Fault terminal.
Catch The output terminal to which the message is routed if an exception is thrown downstream and caught by this node.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).

The SOAPAsyncResponse node Description properties are described in the following table:

Property M C Default Description
Node name No No The node type The name of the node.
Short Description No No None A brief description of the node.
Long Description No No None Text that describes the purpose of the node in the message flow.

The SOAPAsyncResponse node Basic properties are described in the following table:

Property M C Default Description
Correlation ID Yes     Specify the unique URL fragment that is common to your pair of SOAPAsyncRequest and SOAPAsyncResponse nodes.
Draft comment:
Toolkit says : "specify unique URL fragment common for a pair of asynchronous request/response nodes". Feature doc says "Enter the name of the of the corresponding asynchronous request node." Which is right?

The SOAPAsyncResponse node Advanced property is described in the following table:

Property M C Default Description
Set destination list     Selected Check box.
Label prefix       Enter if a prefix is required.

The SOAPAsyncResponse node Administration properties are described in the following table:

Property M C Default Description
Component level     Flow Valid values are Node and Flow.
Additional instances     0  

The SOAPAsyncResponse node Response Message Parsing properties are described in the following table:

Draft comment:
Same as SOAPRequest node
Property M C Default Description
Message domain     SOAP  
Message set Yes     Enables you to select any message set that supports the SOAP domain.

The SOAPAsyncResponse node Parser options properties are described in the following table:

Draft comment:
Similar to SOAPRequest node + message set ( But Message set is on Response Message Parsing!)
Property M C Default Description
Parse timing     On Demand Valid values are Immediate, On Demand, and Complete.
Build tree using XML schema data types       Check box.
Retain mixed content       Check box.
Retain comments       Check box.
Retain processing instructions       Check box.
Opaque elements       This property contains an elements table. You can Add, Edit and Delete in this table.

The SOAPAsyncResponse node Validation properties are described in the following table:

Draft comment:
Same as SOAPRequest node
Property M C Default Description
Validate     Content and value Valid values are None, Content and value, and Content.
Failure action     User trace Valid values are User trace, Exception list, Local error log, and Exception.
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:21:29

ac56210_.dita This topic's URL is:
End of change