Home > Articles > Web Services > SOA

This chapter is from the book

3.3 Simple Object Access Protocol (SOAP)

Although originally conceived as a technology to bridge the gap between disparate RPC-based communication platforms, SOAP has evolved into the most widely supported messaging format and protocol for use with XML Web services. Hence the SOAP acronym is frequently referred to as the Service-Oriented Architecture (or Application) Protocol, instead of the Simple Object Access Protocol.

The SOAP specification establishes a standard message format that consists of an XML document capable of hosting RPC and document-centric data (see Figure 3.19). This facilitates synchronous (request and response) as well as asynchronous (process-driven) data exchange models. With WSDL establishing a standard endpoint description format for applications, the document-centric message format is much more common.

03fig19.gifFigure 3.19 SOAP establishes two primary standard message formats.

The architectures we explore throughout this book make reference to both types of message formats using the standard diagram symbols provided in Figures 3.20 and 3.21.

03fig20.gifFigure 3.20 The symbol used to represent a SOAP message with a document-centric payload.

03fig21.gifFigure 3.21 The symbol used to represent a SOAP message with an RPC-centric payload.

Additionally, we discuss the use of SOAP message attachments, which are described in separate second-generation Web services specifications. (Specifically, the WS-Attachments and SOAP Messages with Attachments (SwA) standards, are covered in Chapter 4.) SOAP messages containing attachments are represented with the symbol shown in Figure 3.22.

03fig22.gifFigure 3.22 The symbol used to represent a SOAP message delivering its data as an attachment.

3.3.1 SOAP messaging framework

SOAP institutes a method of communication based on a processing model that is in relative alignment with the overall Web services framework described at the beginning of this chapter. It differs only in that it introduces terms and concepts that relate specifically to the manner in which SOAP messages need to be handled (within a technical implementation of this framework).

Note that the diagram symbols used to identify SOAP nodes in the following sections are not displayed in other chapters. Their existence is implied in subsequent architectural diagrams that include Web services.

SOAP nodes

A SOAP node represents the processing logic responsible for transmitting, receiving, and performing a variety of processing tasks on SOAP messages. An implementation of a SOAP node is typically platform specific, and is commonly labeled as a SOAP server or a SOAP listener. Specialized variations also exist, such as SOAP routers. Conceptually, all are considered SOAP nodes. Figure 3.23 establishes the SOAP node as the underlying transport mechanism for a Web service.

03fig23.gifFigure 3.23 A SOAP node.

SOAP nodes are best viewed as the technical infrastructure that powers all of the communication scenarios explored in the earlier section, “Web service interaction.” When discussing the involvement of SOAP nodes, however, a slight departure from the terms and concepts established by the Web services framework needs to be incorporated.

SOAP node types

Like Web services, SOAP nodes can exist as initial senders, intermediaries, and ultimate receivers. Whereas Web services are also classified as requestors and providers, SOAP nodes performing the equivalent tasks (sending, receiving) are referred to as SOAP senders and SOAP receivers (see Figure 3.24). The SOAP specification, however, does not classify these as roles. For the purpose of this book, we'll refer to them as “types” of SOAP nodes.

03fig24.gifFigure 3.24 Fundamental SOAP node types along a message path.

As illustrated in Figure 3.25, a node type of SOAP initial sender is also a SOAP sender, and the SOAP ultimate receiver is also a SOAP receiver.

03fig25.gifFigure 3.25 SOAP nodes with multiple types.

Figure 3.26 shows how a SOAP node, acting as an intermediary, transitions through both SOAP sender and receiver types during the processing of a SOAP message.

03fig26.gifFigure 3.26 A SOAP node going through the transition of being a SOAP receiver and sender during the processing of a SOAP message.

As with Web service roles, the same SOAP node can act as different types depending on its position within the message path and the state of the current business activity. For instance, a SOAP node transmitting a message as the initial sender can later receive a response as the ultimate receiver.

Roles for SOAP nodes also exist, but are described separately at the end of this section.

3.3.2 SOAP message structure

The container of SOAP message information is referred to as a SOAP envelope. Let's open it and take a brief look at the underlying structure of a typical SOAP message.

The root Envelope element that frames the message document consists of a mandatory body section and an optional header area.

Example 3.9. A skeleton envelope construct

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
  <env:Header>
    ...
  </env:Header>
  <env:Body>
    ...
  </env:Body>
</env:Envelope>

The SOAP header is expressed using the Header construct, which can contain one or more sections or blocks.

Example 3.10. The Header construct with a header block

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
  <env:Header>
    <n:shipping >
      UPS
    </n:shipping>
  </env:Header>
  <env:Body>
    ...
  </env:Body>
</env:Envelope>

Common uses of header blocks include:

  • implementation of (predefined or application-specific) SOAP extensions, such as those introduced by second-generation specifications

  • identification of target SOAP intermediaries

  • providing supplementary meta information about the SOAP message

While a SOAP message progresses along a message path, intermediaries may add, remove, or process information in SOAP header blocks. Although an optional part of a SOAP message, the use of the header section to carry header blocks is commonplace when working with second-generation Web services specifications.

The one part of a SOAP message that is not optional is the body. As represented by the Body construct, this section acts as a container for the data being delivered by the SOAP message. Data within the SOAP body is often referred to as the payload or payload data.

Example 3.11. The Body construct

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
  <env:Header>
    ...
  </env:Header>
  <env:Body>
    <x:Book xmlns:x="http://www.examples.ws/">
      <x:Title>
        Service-Oriented Architecture
        A Field Guide to Integrating XML
        and Web services
      </x:Title>
    </x:Book>
  </env:Body>
</env:Envelope>

The Body construct can also be used to host exception information within nested Fault elements. Although fault sections can reside alongside standard data payloads, this type of information is often sent separately in response messages that communicate error conditions.

The Fault construct consists of a series of system elements used to identify characteristics of the exception.

Example 3.12. A sample fault construct providing error information

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
  <env:Body>
    <env:Fault>
      <env:Code>
        <env:Value>
          env:VersionMismatch
        </env:Value>
      </env:Code>
      <env:Reason>
        <env:Text xml:lang="en">
          versions do not match
        </env:Text>
      </env:Reason>
    </env:Fault>
  </env:Body>
</env:Envelope>

SOAP node roles

Now that you've had a look at the internal structure and syntax of a SOAP message, let's finish by briefly introducing SOAP node roles. When discussing SOAP nodes, roles relate to an optional env:role3 attribute that a SOAP message can use to identify header blocks intended for specific types of SOAP receivers. Therefore, SOAP roles are associated only to types of SOAP nodes that perform a receiving function. In other words, intermediaries and ultimate receivers (see Figure 3.27).

03fig27.gifFigure 3.27 Roles that can be assumed by receiving SOAP nodes

The two most common env:role attribute values are next and ultimateReceiver. An intermediary node will process only header blocks identified with the next role, whereas a node acting as the ultimate receiver will process both.

To learn more about SOAP, header blocks, and how they relate to second-generation Web services, visit www.specifications.ws.

SUMMARY OF KEY POINTS

  • Implementations of the SOAP messaging framework can be collectively conceptualized as an end-to-end messaging engine that drives communication throughout contemporary service-oriented architectures.

  • A SOAP message consists of a simple XML document structure. The parent envelope construct houses an optional header and a required body construct. Exception information can be placed in a special Fault element that is nested within the message body.

  • The utilization of SOAP header blocks by second-generation Web services specifications is an important aspect of this framework that vastly increases its power and complexity.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020