Configuring CICS to support MTOM/XOP for other SOAP pipelines

CICS® SOAP pipelines can support the Message Transmission Optimization Mechanism (MTOM) and XML-binary Optimized Packaging (XOP) specifications. These specifications define a mechanism for sending and receiving binary data using SOAP, without incurring the overhead of base64 encoding. To enable MTOM support, you must configure your pipelines accordingly. This instruction is intended for pipelines that do not use the <cics_soap_1.1_handler_java> or <cics_soap_1.2_handler_java> handlers. To enable MTOM/XOP support for non-Java pipelines, you must add the MTOM handler to your pipeline configuration files.

Before you begin

Before performing this task, you must identify or create the pipeline configuration files to which you will add configuration information for MTOM/XOP.

Review Restrictions for other SOAP pipelines.

Procedure

Add a <cics_mtom_handler> element to your pipeline configuration file.
This element should be first in the <provider_pipeline> element, and the last element before the <service_parameter_list> in the <requester_pipeline> element.
Code the following elements:
```
<cics_mtom_handler>
	 <dfhmtom_configuration version="1">
  </dfhmtom_configuration>
</cics_mtom_handler>
```
The <dfhmtom_configuration> element is a container for the other elements in the configuration. If you want to accept the default settings for MTOM/XOP processing, you can specify an empty element as follows:
```
	 <cics_mtom_handler/>
```
Optional: Code an <mtom_options> element.
In both a service provider and service requester pipeline, this element specifies whether the outbound message should be packaged as an MTOM message.
1. Code the send_mtom attribute to define if the outbound message should be sent as an MTOM message.
2. Code the send_when_no_xop attribute to define if the outbound message should be sent as an MTOM message when there are no binary attachments present.
Optional: Code a <xop_options> element with an apphandler_supports_xop attribute.
This specifies if the application handler is capable of handling XOP documents directly. If you do not include this attribute, the default depends on whether the <apphandler> element specifies DFHPITP or another program.
Optional: Code a <mime_options> element with a content_id_domain attribute.
This specifies the domain name that should be used when generating MIME content-ID values, that are used to identify binary attachments.

Example

The following example shows a completed <cics_mtom_handler> element in which all the optional elements are present.

<provider_pipeline>
  <cics_mtom_handler>
    <dfhmtom_configuration version="1">
      <mtom_options send_mtom="same" send_when_no_xop="no" />
      <xop_options apphandler_supports_xop="yes" />
      <mime_options content_id_domain="example.org" />
    </dfhmtom_configuration>
  </cics_mtom_handler>
....
</provider_pipeline>