SOAP Reference Binding

Using SOAP reference binding you can create a service consumer using SOAP protocol.

Note: It is recommended to use the HTTP Client Shared Resource when configuring SOAP Reference Binding. Response received for a transport communication error might be different if compared with response received using the HTTP Client shared resource.

Binding

This section has the following fields.

Field Description
Name The name of the reference binding.
Description A short description of the HTTP reference binding.
WSDL Service Specifies the service name and its target namespace.
WSDL Port Specifies the binding implemented by the service. If more than one implementation is available in concrete WSDL, select an appropriate implementation.
SOAP Version The version of the SOAP specification: 1.1 or 1.2.
Attachment Style The attachment style for the incoming and outgoing messages. The following attachment styles are available:
  • SwA
  • MTOM

The MTOM attachment style is available if SOAP 1.1 or SOAP 1.2 specification is used.

Enable DefaultFaultElement Select the check box to enable the fault DefaultFaultElement on the Invoke activity.

By default the check box is not selected.

Ignore mustUnderstand Select this check box to ignore the value of the mustUnderstand attribute, in the incoming request, when the attribute is set to true.

By default the check box is not selected.

Enable CustomFaultElement Select this check box to add the faultCode, faultString, and faultActor attributes in the custom fault element on the Invoke activity.

By default the check box is not selected.

Transport Configuration

This section has the following fields.

Field Literal Value/Module Property Description
Transport Type None The transport over which the SOAP message is sent. HTTP and JMS transports are supported.
Application for HTTP Transport
Default Host/Port None Specifies the default host and port configuration available in the concrete WSDL.
HTTP Client Name Yes Name of the HTTP Client resource.
Note:  
  • Click the icon to select a shared resource for the HTTP client.
  • Apache Axis2 library is upgraded. So, the SOAP Reference Binding supports Apache HttpComponents implementation library only, instead of Apache Commons library.
Endpoint URI Yes The endpoint of the service through which SOAP clients can access the service.
Application for JMS Transport
JMS Connection Name None Name of the JMS Connector resource
JMS Destination Yes Specifies the name of the destination for the incoming JMS messages. The syntax of the destination name is specific to the JMS provider you are using.
Messaging Style None Specifies the style of the incoming messages on the specified destination. It can be Generic, Queue, or Topic.
Message Type None Specifies the type of the incoming messages on the specified destination. It can be either Text Message or Bytes Message.
Delivery Mode No The delivery mode of messages.
  • Persistent Messages are stored and forwarded.
  • Non-Persistent Messages are not stored and can be lost due to failure.

The default is Persistent.

Expiration Yes The length of time a message can remain active. 0 means that the message does not expire.
Priority Yes 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).

The default is 4.

JMS Application Properties None The user-defined JMS Properties required to be available in the incoming message.
JMS Application Properties(Response) None The user-defined JMS Properties required to be sent in the outgoing message.

Persistence Configuration

This section has the following fields.

Field Literal Value/Module Property Description
Persistence Type None Select any one from the available persistence configuration types.
  • None
  • File

Selecting the File option displays the Directory, Create Directories, and Threshold Size fields.

Directory Yes The directory to write attachments that exceed the specified threshold size.
Create Directories Yes Creates new directories if not already present on the disk.
Threshold Size Yes The maximum size (in bytes) of an incoming message attachment that can be kept in memory. Attachments larger than the specified size are written to a file in the specified directory.

The file name is the output, so that subsequent activities in the process can access the file and read its contents.

Threading Policy Details

The following are the details about the SOAP Reference Binding threading policy.

Activity Type Multi-Threaded? Default Thread Count Thread Count Configuration
Transport: HTTP
Asynchronous Yes
  • Core pool size = 5
  • Max pool size =10
You can either configure it by using the Thread Pool shared resource or by providing it in the config.ini using the following properties:
  • com.tibco.bw.palette.http.requestresponse.threadpool.coresize
  • com.tibco.bw.palette.http.requestresponse.threadpool.maxsize

Policy

Bindings that support policies display the Policy field. To associate a new or existing policy with the SOAP HTTP Reference Binding, click the Add Policy icon. To edit policy details, click Policy Name. The Policy section has the following fields.

Field Description
Policy Name The name of the policy.
Policy Type The type of policy associated with the binding. The SOAP HTTP Reference Binding can support the WSS Consumer policy.
Description A description of the policy.