Use the HTTPReply node to return a response from the message flow to the Web service client. This node generates the response to the Web service client from which the input message was received by the HTTPInput node, and waits for confirmation that it has been sent.
This topic contains the following sections:
The HTTPReply node can be used in any message flow that needs to accept HTTP or HTTPS messages. The most common example of this is a message flow that implements a Web service. For information on Web service applications, see Web service applications.
If you include an HTTPReply node in a message flow, you must either include an HTTPInput node in the same flow, or the message must be received from another flow that is running in the same broker, and that started with an HTTPInput node. The response is associated with the reply by a request identifier that is stored in LocalEnvironment by the HTTPInput node.
This node constructs a reply message for the Web service client from the entire input message tree, and returns it to the requestor.
The HTTPReply node is represented in the workbench by the following icon:
When you have put an instance of the HTTPReply node into a message flow, you can configure it. To display its properties, either double-click the node, or right-click the node and click Properties.
All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
Configure the HTTPReply node.
The node always includes, in the HTTPReplyHeader, a Content-Length header, which is set to the correct calculated value, even if this was not included in the original request.
For more details, refer to Validating messages.
The HTTPReply node terminals are described in the following table.
Terminal | Description |
---|---|
In | The input terminal that accepts a message for processing by the node. |
Failure | The output terminal to which the message is routed if a failure is detected when the message is propagated. |
Out | The output terminal to which the message is routed if it has been propagated successfully, and if further processing is required within this message flow. |
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 HTTPReply node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type, HTTPReply | The name of the node. |
Short Description | No | No | A brief description of the node. | |
Long Description | No | No | Text that describes the purpose of the node in the message flow. |
The HTTPReply node Basic properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Ignore Transport Failures | Yes | No | Selected | If you select the check box, transport-related failures are ignored. |
Reply send timeout (sec) | Yes | No | 120 | The time in seconds that the HTTPReply node waits before assuming that the reply has failed to reach the client. The valid range is zero (which means an indefinite wait) to (231)-1. This property is valid only if Ignore Transport Failures is cleared. |
Generate default HTTP headers from reply or response | Yes | No | Selected | If you select the check box, the default Web service headers are created using values from the HTTPReplyHeader or HTTPResponseHeader. |
The Validation properties of the HTTPReply node are described in the following table.
Refer to Validation properties for a full description of these properties.
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | Yes | Yes | Inherit | This property controls whether validation takes place. Valid values are None, Content and Value, Content, and Inherit. |
Failure Action | Yes | No | Exception | This property controls what happens if validation fails. You can set this property only if you set Validate to Content or Content and Value. Valid values are User Trace, Local Error Log, Exception, and Exception List. |
Include All Value Constraints | Yes | No | Selected | This property cannot be edited. The default action, indicated by the check box being selected, is that basic value constraint checks are included in Content and Value validation. |
Fix | Yes | No | None | This property cannot be edited. |