This topic describes the SOAPAsyncRequest node.
Use the SOAPAsyncRequest node in conjunction with the SOAPAsyncResponse 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
http://thisEG:7080/correspondingAsyncResponseNodeIDThe SOAP role for this node is set to RequestingSOAPNode. Although the SOAPAsyncRequest node is similar to the input side of the HTTPRequest node, the SOAPAsyncRequest node does not have the advanced properties for selecting which part of the message is sent to the remote Web server because the SOAPAsyncRequest node expects to send a fully formed SOAP message in the SOAP domain. The message that leaves the Out terminal is the same as the message that arrived at the In terminal.
The SOAPAsyncRequest node is WSDL-driven, in a similar manner to the SOAPRequest node.
The SOAPAsyncRequest 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 SOAPAsyncRequest 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.
If you make a new selection then the WSDL file is validated. The WSDL validation is the same as the validation that is done when you drag and drop the WSDL file onto a flow. After the file is validated the message set to which it belongs is added as a reference project if it does not already exist.
If the WSDL file is not validated, or an incorrect file name is entered, an error message is displayed on the editor and the corresponding WSDL properties are blank.
If the same WSDL file name is entered into the text box then no validation or updates occur. To refresh the WSDL file contents click Browse, or drag and drop the WSDL file onto the node.
Both ends of an SSL connection must use the same protocol. The protocol must be one that the remote server can accept.
The SOAPAsyncRequest 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. |
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 SOAPAsyncRequest 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 SOAPAsyncRequest 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? |
||
WSDL file name Draft comment:
(Same as SOAPInput node) |
Yes | This property type is String. You can change the WSDL
file you use to configure this node in the following ways:
|
||
Port type Draft comment:
(Same as SOAPInput node) |
Yes | By default, the first Port type found in the WSDL, that has an associated HTTP binding with it, is selected. | This property type is String. The field lists all of
the Port types defined in the WSDL
document. Error Conditions:
|
|
Imported binding Draft comment:
(Same as SOAPInput node) |
Yes | This property type is String. This property is updated every time that the Port type value changes. The field lists all of the SOAP bindings with HTTP transport (6.1) associated with the selected Port type. Bindings are listed in the same order in which they appear in the WSDL source. The selected binding is the one that has both ports and operations. If there is no such binding, then binding with ports is selected. If no bindings have ports then the first binding in the list is selected. Error Conditions:
|
||
Binding operation | Yes | This property type is String. This field lists all of the operations defined by the selected Port type. The first operation in the list is selected by default. |
||
Service port Draft comment:
(Same as SOAPInput node) |
Yes | This property type is String. This field is updated
every time that the selected binding is updated. This field lists all of the
WSDL ports that point to the selected binding. The first port for the binding
is the selected port by default. Error Conditions:
|
||
Target namespace | Target namespace is
implemented as a read-only field. This property is a hidden String property. It is updated with the Target namespace of the WSDL when the WSDL file name is configured. |
The SOAPAsyncRequest node HTTP Transport properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Web service URL Draft comment:
(Same as HTTPRequest node) |
Yes | (Yes) | This property type is String. The URL for the Web service.
This property is automatically set from the SOAP address of the selected port.
However, if you override the value then your value persists, and the URL is
not configured from the service port. You must provide this property in
the form http://<hostname>[:<port>]/[<path>] where:
|
|
Request timeout (in seconds) | 120 | This property type is Integer. This property has the
value of the wait time for the remote server to respond with an acknowledgement
that the message has been received. The time in seconds that the node waits for a response from the Web service. The valid range is 1 to (231)-1. You cannot enter a value that represents an unlimited wait. |
||
HTTP(S) proxy location Draft comment:
(Same as HTTPRequest node) |
No | Yes | This property type is String. The proxy server to which requests are sent. This value must be in the form hostname:port. | |
SSL Protocol (if using SSL) Draft comment:
(Same as HTTPRequest node) |
No | Yes | ssl | This property type is Enum. The SSL protocol to use
when making an HTTPS request. Valid values are:
|
Allowed SSL ciphers (if using SSL) Draft comment:
(Same as HTTPRequest node) |
No | Yes | This property type is String. A comma-separated list of ciphers to use when making an SSL request. The default value of an empty string means use all available ciphers. | |
useHttpTransport | This is a hidden Boolean property on this tab. It is set to true when the WSDL file name property is configured. |
The SOAPAsyncRequest node Advanced properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Must understand headers | The Must understand
headers column is immediately to the left of the Header
name column and contains a check box for each header. The check box
is automatically selected for all of the entries in the WSDL-defined
SOAP headers table. You must ensure that the Must understand headers check box for the newly added custom header is selected in order for the header to be added to the Must understand headers list. The Must understand headers property configured on this tab will be applied to the corresponding SOAPAsyncResponse node that receives the reply from the remote server. |
|||
WSDL-defined SOAP headers | This table is read-only, and is populated by the SOAP headers defined in the output part of the selected operations. The table is updated automatically when the selected operation is updated. This property is generated in the CMF file. | |||
User-defined SOAP headers | You can add custom headers in this table. You can Add, Edit and Delete in this table. This property is generated in the CMF file. |
The SOAPAsyncRequest node Security properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Security profile | No Security | Valid values are:
|
||
Consumer policy | This is a hidden property on the node to override the flow default. |
The SOAPAsyncRequest node WS-Security properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
WS-Security | This complex property is in the form of a table and
consists of two columns:
|