SOAP Binding Reference

You can specify the endpoint, SOAP defaults, service transport, and reference transport for the binding node. You can specify the SOAP general configuration for the operation node, and the part list for the input or output message node.

Binding Node

Binding
Field Required? Editable? Description
Name Y Y The name of the binding.

Default: SOAPService_Bindingn, where n is an integer.

Description N Y A description of the binding.

Default: None.

Target Namespace Y Y The target namespace for a concrete WSDL file for the service.

Default: AbstractWSDLNamespace/BindingName, where AbstractWSDLNamespace is the namespace of the abstract WSDL file of the service and BindingName is the value of the Name field.

SOAP Default Configuration
Field Required? Editable? Description
SOAP Version N Y The version of the SOAP specification: 1.1 or 1.2.

Default: 1.1.

Style Y Y The SOAP binding style: Document or RPC.

Default: Document.

Encoding N N The encoding type for the body of the SOAP input and output messages. Set to Literal.
Service Transport Configuration
Field Required? Editable? Description
Transport Type Y Y The type of transport supported by the binding. HTTP or JMS.
HTTP
Endpoint URL Y Y An absolute URL when its value contains an underscore ("_"), especially in the hostname part of the URL.
Enable WS-Reliable Messaging N Y Indicate whether to enable WS-Reliable Messaging behavior. When checked, the Quality of Service drop-down list displays.

Default: Unchecked.

Quality of Service N Y The level of guarantee for message delivery.

Default: Exactly Once.

Enable WS-Addressing N Y Indicate whether to enable WS-Addressing headers. When checked, the Anonymous checkbox displays.

Default: Unchecked.

Anonymous N Y Indicate whether synchronous responses should be returned to the client when WS-Addressing is enabled.

Default:

Connector Name Y Y The name of the HTTP connector resource instance that provides incoming transport services.

Default: httpConnector.

Session Inactivity Timeout (s) Y Y

Specifies the time, in seconds, between the client requests before the servlet container invalidates the session.

Default: 60.

JMS

Binding Specification Y Y Binding specification supported: TIBCO or W3C SOAP-JMS.

Default: TIBCO.

The thread pool parameters can be configured at a SOAP/JMS service binding level in addition to the node level. The parameters set on a SOAP/JMS service binding take precedence over the values defined at the node level as below:

java.property.com.tibco.amf.bindingtype.soap.endpointPoolSteadySize=10

java.property.com.tibco.amf.bindingtype.soap.endpointPoolMaxSize=15

If neither sets of values are specified, then a system default of 10 and 15 are used for endpointPoolSteadySize and endpointPoolMaxSize respectively.

JMS - Request Configuration
JMS Connection Factory Y Y

A JMS Connection Factory.

JMS Destination Y Y A JMS destination configuration.
Note: Only queues are supported for SOAP/JMS. Topics are not supported.
Acknowledge Mode Y Y The acknowledgment mode for incoming messages. Set to Auto, meaning that the message is automatically acknowledged when it is received.
Message Type Y Y The type of the message content: Text or Bytes.

Default: Text.

JMS - Reply Configuration
JMS Connection Factory Y Y A JMS Connection Factory .
Delivery Mode N Y The delivery mode of messages:
  • Persistent Messages are stored and forwarded.
  • Non-Persistent Messages are not stored and may be lost due to failure.

Default: Persistent.

Correlation Scheme Y Y Scheme which identifies the correlation scheme used when sending reply messages.
  • MessageID to CorrelationID (default) — Message ID of the request message is copied to the Correlation ID of the response message.
  • CorrelationID to CorrelationID — Correlation ID of the request message is copied to the Correlation ID of the response message.
  • Infer from Request — If CorrelationID is present in incoming Request Message, CorrelationID of incoming Request Message is copied to CorrelationID of outgoing Response Message. If CorrelationID is absent in incoming Request Message, MessageID of incoming Request Message (which is always present) is copied to CorrelationID of outgoing Response Message.
    Note: The correlation scheme is applicable only for SOAP/JMS service bindings.

    The correlation scheme is applicable on the reference side as well.

Message Priority N Y The priority of the message. Priority is a value from 0-9. Higher numbers signify a higher priority (that is, 9 is a higher priority than 8).

Default: 4.

Message Expiration (ms) N Y The length of time a message can remain active. 0 means that the message does not expire.

Default: 0.

Reference Transport Configuration
Field Required? Editable? Description
Transport Type Y N The type of transport supported by the binding: HTTP or JMS.
HTTP
HTTP Client Y Y An HTTP Client.
Endpoint URI Y N The Endpoint URI field on reference is a combination of the hostname, port number and the Filespec or Endpoint URL. Though this field is not editable, the Filespec or Endpoint URL part can be changed by providing a complete URL or a URI.

You can also pick or enter a substitution variable for the value, for example, %%MyPartnerEndPoint%%

You can define the value for the substitution variable with a complete URL, for example, http://<host>:<port>/weatherReportPT.

SSL-enabled SOAP/HTTP Endpoints

You can override the protocol value in the Filespec or Endpoint URL field to https:// to enable SSL. This requires pre-configuration of HTTP Client shared resource to use SSL Client Provider. Even if SSL is enabled in the HTTP Client shared resource, the protocol value in that field determines whether SSL is enabled or not.

Note: It is recommended that in TIBCO Business Studio you pick a substitution variable instead of entering it manually so that it is packaged correctly in the DAA and correctly handles the 'Synchronization' state in the Administrator.
Endpoint URI Filespec Y Y The endpoint URI filespec. This field is populated from the SOAP Address element of the WSDL port associated with the SOAP-HTTP reference binding. This value can be edited by typing the new value or by using the Substitution Variables picker to select a substitution variable that points to a valid endpoint URI value.
Override HTTP Client Socket Timeout N N A boolean field check box representing whether the "Binding Socket Timeout" value is to be used (when true), or ignored (when false).
Binding Socket Timeout N N

An integer field representing a timeout value in milliseconds for a synchronous reply to arrive when an external service is invoked. It accepts substitution variables. This value is used only when the Override HTTP Client Socket Timeout is selected. This field is equivalent to the field Socket Timeout of the HTTP Client resource template.

Enable WS-Reliable Messaging N Y Indicate whether to enable WS-Reliable Messaging behavior. When checked the Quality of Service drop-down list displays and the Enable WS-Addressing and Anonymous checkboxes are checked.

Default: Unchecked.

Quality of Service N N The level of guarantee for message delivery.

Default: Exactly Once.

Enable WS-Addressing N Y Indicate whether to enable WS-Addressing headers. When checked, the Anonymous checkbox displays and is checked.

Default: Unchecked.

Anonymous N Y Indicate whether synchronous responses should be returned to the client when WS-Addressing is enabled. When unchecked, the Connector Name field displays.

Default: Checked.

Connector Name N Y The name of the connector to which responses should be sent.

Default: None.

JMS

Binding Specification Y N Binding specification supported: TIBCO or W3C SOAP-JMS.

Default: TIBCO.

JMS - Request Configuration
Connection Factory Y Y

A JMS Connection Factory.

Destination Y Y A JMS destination configuration.

Only queues are supported for SOAP/JMS. Topics are supported in a limited way; only SOAP/JMS reference bindings containing one-way operations (exclusively) with topics as destinations can be enabled by adding the following line to the node's TRA and restarting the node:

java.property.com.tibco.amf.bindingtype.soap.suppressTopicUnsupportedError=true

Delivery Mode Y Y The delivery mode of messages:
  • Persistent Messages are stored and forwarded.
  • Non-Persistent Messages are not stored and may be lost due to failure.

Default: Persistent.

Message Priority Y Y The priority of the message. Priority is a value from 0-9. Higher numbers signify a higher priority (that is, 9 is a higher priority than 8).

Default: 4.

Message Expiration (ms) Y Y The length of time a message can remain active. 0 means that the message does not expire.

Default: 0.

JMS - Reply Configuration
Destination Y Y A JMS destination configuration.
Note: Only queues are supported for SOAP/JMS. Topics are not supported.
Acknowledge Mode Y N The acknowledgment mode for incoming messages. Set to Auto, meaning that the message is automatically acknowledged when it is received.
Correlation Scheme Y Y Scheme which identifies the correlation scheme used when sending reply messages.
  • MessageID to CorrelationID (default) — Message ID of the request message is copied to the Correlation ID of the response message.
  • CorrelationID to CorrelationID — Correlation ID of the request message is copied to the Correlation ID of the response message.
Note: The correlation scheme is applicable only for SOAP/JMS service bindings.

The correlation scheme is applicable on the reference side as well.

Operation Node

SOAP General Configuration
Field Required? Editable? Description
SOAP Action Y Y The SOAP action that is expected from incoming SOAP requests. See the SOAP specification for more information about SOAP action.
Style Y Y Document, RPC, or Inherit from parent endpoint.
Encoding Y Y Literal.

Input or Output Message Node

Part List
Field Description
Part Name The name of the message part.
Part Type The type of the message part: Body or Header.