This topic describes the SOAPInput node.
Use the SOAPInput node to process client SOAP messages, thus enabling the broker to be a SOAP Web services provider.
The SOAPInput node is contained in the Web Services drawer of the message flow node 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 SOAPInput node into a message flow, you can configure it. For more information, see Configuring a message flow node. 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.
When you have made a new selection the WSDL file is validated. The WSDL validation is exactly 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 file name is entered into the text box, no validation or updates occur. In order to refresh the WSDL file contents click Browse, or drag and drop the WSDL file onto the node.
If the address contains https URL, the box is marked, otherwise it is not.
However, if you override this property with another value, this value persists. This means that the value is not configured from the service port URL anymore if you change the Use HTTPS value.
Predefined roles are specified in the respective SOAP 1.1 or /SOAP 1.2 specifications, and are used to process SOAP Headers targeted at the specific role.
The default prefix is an empty string so that the operation name and the label name are identical, but the field displays the user instruction: <enter a prefix if required>. This property is not enabled if the setDestinationList property is not enabled.
This prevents the Axis 2 server from signaling SOAP fault, should the SOAP input message contain one or more of such headers with the must understand bit turned on.
By default, Must understand check boxes are selected for ALL entries in the WSDL-defined table. When the selected binding is updated, the WSDL-defined header table is updated accordingly.
You can add custom headers, that is, headers not defined in the WSDL, in the user-defined table. This table includes Add, Edit, and Remove buttons. You need to select the must understand checkbox for the newly added custom header, in order for the header to be added to the must understand headers list.
In this situation an exception list is sent down the Failure terminal with the inbound message as a BLOB. The default value of this property is False.
The field is pre-populated with Content and Value.
The alias is resolved in a Policy Set that is created by the administrator. The Policy Set resolves the alias to either encrypt or sign the part of the message referred to by the XPath expression.
The SOAPInput 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. |
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 SOAPInput 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 SOAPInput node Basic properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
WSDL file name | Yes | No | <None> | The name of the WSDL file used to configure this node |
Port type | Yes | No | From WSDL | The selected port type from the WSDL file |
Imported binding | Yes | No | From WSDL | The selected binding from the WSDL file |
Service port | Yes | No | From WSDL | The selected port from the WSDL file |
Target namespace | Yes | No | From WSDL | The target namespace from the WSDL file |
The SOAPInput node HTTP Transport properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
URL selector | Yes | Yes | None | The HTTP path selector upon which the node accepts inbound messages |
Use HTTPS | No | Yes | False | If the address contains https URL, the box is marked, otherwise it is not. |
Maximum client wait time (sec) | Yes | Yes | 180 | The time the client waits for a for a remote server to respond with a 'message received' acknowledgement. |
The SOAPInput node Advanced properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
SOAP 1.1 actor (SOAP 1.2 role) | Yes | No | Ultimate receiver | The SOAP role the receiver is acting in |
Enable WS-Addressing | No | Yes | True | Whether to engage Web Services Addressing. |
Set destination list | No | No | True | Whether to add the method binding name to the route to label destination list. By default it is added so a route to label node straight after the node works. |
Label prefix | No | No | None | The prefix to add to the method name when routing to label. This is enabled only if Set Destination List is true. |
WSDL defined SOAP headers Header name | Yes | No | Must understand selected | Populated, based on the defined SOAP headers. |
WSDL defined SOAP headers Header namespace | Yes | No | Must understand selected | Populated, based on the defined SOAP headers. |
WSDL defined SOAP headers Operation name | Yes | No | Must understand selected | Populated, based on the defined SOAP headers. |
User defined SOAP headers Header name | No | Yes | None | Custom header name |
User defined SOAP headers Header namespace | No | Yes | None | Custom header namespace |
User defined SOAP headers Operation name | No | Yes | None | Custom header operation name |
The SOAPInput node Input Message Parsing properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Message domain | Yes | No | SOAP | The value of the message domain can not be changed. |
Message set | Yes | No | The value of the message set project value on drag and drop of WSDL | The value of the message set can not be changed. |
Message type | Yes | No | Blank | The value of the message type can not be changed. |
Message format | Yes | No | Blank | The value of the message format can not be changed. |
The SOAPInput node Parser Options properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Parse timing | Yes | Yes | On demand | If a parser is capable of parsing an input bit stream on demand, instead of immediately parsing the entire bit stream, the Parse Timing property of a message flow node controls the on demand behavior of the parser. You can set the Parse Timing property to On Demand (the default), Immediate, or Complete. |
Build tree using XML schema data types | No | Yes | False | |
Retain mixed content | No | Yes | False | |
Retain comments | No | Yes | False | |
Retain processing instructions | No | Yes | False | |
Opaque elements | No | Yes | Blank |
The SOAPInput node Error Handling property is described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Send failures during inbound SOAP processing to failure terminal | No | Yes | False | During inbound SOAP processing, send any fault to the Failure terminal |
The SOAPInput node Validation properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | No | Yes | Content and value | Schema validation properties |
Failure action | No | Yes | User trace |
The SOAPInput node Security properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Identity token type | No | Yes | None | The format of the identity token. |
Identity token location | No | Yes | Blank | The location of the identity token. This must resolve to a token set in Identity Token Type |
Identity password location | No | Yes | Blank | Only applicable if Username and password is selected. |
Identity issued by location | No | Yes | None | An expression specifying where the identity was defined. |
Security profile | No | Yes | No security | Value for the security profile in which you can enter your own value. |
Treat security exceptions as normal exceptions | No | Yes | False | Whether security exceptions are treated as normal exceptions. |
The SOAPInput node WS-Security properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Alias | No | Yes | This is the alias value associated with an XPath expression. This option is related to Web-services security only. | |
XPath Expresssion | No | Yes | The XPath expression added to the Web Services security table. This option is related to Web-Services security only. |
The SOAPInput node Retry properties are described in the following table:
Property | M | C | Default | Description |
---|---|---|---|---|
Retry mechanism | No | No | Failure | |
Retry threshold | No | Yes | 0 | |
Short retry interval | No | Yes | 0 | |
Long retry interval | No | Yes | 0 |