This topic describes the SOAPAsyncResponse node.
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
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.
The SOAPAsyncResponse node is contained in the Web Services drawer of the palette, and is represented in the workbench by the following icon:
You can view samples only when you use the information center that is integrated with the Message Brokers Toolkit.
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.
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:
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:
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:
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. |