IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

SOAP parser and domain

You can use the SOAP parser to create a common WSDL-based logical tree format for working with Web services, independent of the physical bitstream format.

Use the SOAP parser in conjunction with the SOAP nodes in your message flow.

Messages in the SOAP domain are processed by the SOAP parser. The SOAP parser creates a common logical tree representation for all SOAP-based Web services and validates the message against a WSDL definition. If a runtime message is not allowed by the WSDL, an exception is thrown, otherwise the portType and operation names from the WSDL are saved in the logical tree.

The SOAP domain offers WS-* processing, together with a canonical tree shape that is independent of the wire format (XML or MIME).

The standards supported are:

A WSDL 1.1 definition must be deployed to describe the web service messages that the SOAP domain needs to parse and write at run time. Therefore, the SOAP parser is always model-driven. The bitstream format for these runtime messages can be SOAP 1.1 or SOAP 1.2, optionally wrapped by MIME as an SwA (SOAP with Attachments) or MTOM message.

When an application, library, or message set that supports the SOAP domain is added to a broker archive (BAR) file, XML schemas are created automatically. WSDL files in the application, library, or message set are added to the BAR file. The WSDL and XML schemas are deployed to the broker and used by the SOAP parser.

If you want the SOAP domain to parse your SOAP Web service, complete the following steps:
  1. Create an application or library. Alternatively, you can create a message set, or locate an existing message set.
  2. If you are using a message set, indicate that the message set supports the SOAP domain by either setting the default message domain project to SOAP, or select the SOAP check box (under Supported message domains).
  3. To create a message root (in an application or library) or a message definition file (in a message set), import your WSDL file into the application, library, or message set. Message roots or message definition files for the SOAP envelope and the SOAP logical tree are also added to the application, library, or message set automatically.
  4. Add the application, library, or message set to a broker archive (BAR) file.

    If the WSDL was in an application or library, the WSDL files and XSD files appear directly inside the .appzip or .libzip file inside the BAR file. If the WSDL was in a message set, the required XML schema and WSDL files are generated in a file with extension .xsdzip.

  5. Deploy the BAR file to the broker.
  6. If you associate your WSDL with a SOAP node in your message flow, the Message domain property on the node is automatically set to SOAP and cannot be changed. If you are using a message set, the Message model property is automatically set to the name of the message set that contains the WSDL and cannot be changed. If you are using an application or library, the Message model property is empty and cannot be changed.
Tip: The SOAP parser invokes the XMLNSC parser to parse and validate the XML content of the SOAP Web service. See XMLNSC parser.
Related concepts:
What is SOAP?
SOAP message details
SOAP tree overview
Parsers
XMLNSC parser
Message modeling
Related tasks:
Designing a message flow
Related reference:
Built-in nodes
Message model reference information
ac64000_.htm | Last updated Friday, 21 July 2017