HTTPHeader node
Use the HTTPHeader node to add, modify, or delete HTTP headers such as HTTPInput, HTTPResponse, HTTPRequest and HTTPReply.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
This topic contains the following sections:
Purpose
HTTPInput and HTTPResponse headers can only be deleted or carried forward from the incoming message; their header properties cannot be modified or added to.
The HTTPHeader node is contained in the HTTP drawer of the palette, and is represented in the IBM Integration Toolkit by the following icon:
Terminals and properties
When you have put an instance of the node into a message flow, you can configure it; see Configuring a message flow node. This node has no mandatory properties.
HTTPHeader 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 input message is routed if a failure is detected during extraction. |
Out | The output terminal to which the transformed message is routed if the input message is processed successfully. |
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 HTTPHeader node Description properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | HTTPHeader | 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. |
Property | M | C | Default | Description |
---|---|---|---|---|
HTTPInput Header Options | No | Yes | Carry forward header | Options to control the HTTPInputHeader as a whole. Select Carry forward the header to carry forward values from incoming message if present. Select Delete header to delete the header if present. |
Property | M | C | Default | Description |
---|---|---|---|---|
HTTPResponse Header Options | No | Yes | Carry forward header | Options to control the HTTPResponseHeader as a
whole. Select Carry forward the header to carry forward values from incoming message if present. Select Delete header to delete the header if present. |
Property | M | C | Default | Description |
---|---|---|---|---|
HTTPRequest Header Options | No | Yes | Carry forward header | Configure the HTTPRequest header. These options are available. |
Clear incoming values | No | Yes | Cleared | This option, which is enabled only if you choose Modify header, removes all property names and associated values from the incoming message if present. |
HTTPRequest Header | No | Yes | No default value | This field is enabled only if you chose Add header or Modify header for the HTTPRequest Header Options. The screen has no predefined properties; you use it to create custom properties and values. Use the property table to add new properties, or modify or delete existing properties, for the header. There is no limit to the number of properties. Each property must have a name and a type qualifier. The type qualifier can be Value, XPath, or Delete. |
HTTPReply Header properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
HTTPReply Header Options | No | Yes | Carry forward header | Configure the HTTPReply header. These options are available. |
Clear incoming values | No | Yes | Cleared | This option, which is is enabled only if you choose Modify header, removes all property names and associated values from the incoming message if present. |
HTTPReply Header | No | Yes | No default value | This field is enabled only if you chose Add header or Modify header for HTTPRequest Header Options. The screen has no predefined properties; you use it to create custom properties and values. Use the property table to add new properties, or modify or delete existing properties, for the header. There is no limit to the number of properties. Each property must have a name and a type qualifier. The type qualifier can be Value, XPath, or Delete. |
Property | M | C | Default | Description |
---|---|---|---|---|
Events | No | No | None | Events that you have defined for the node are
displayed on this tab. By default, no monitoring events are defined
on any node in a message flow. Use Add, Edit,
and Delete to create, change or delete monitoring
events for the node; see Configuring monitoring event sources by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |