Home > Articles > Programming > Java

This chapter is from the book

SOAP Intermediaries

So far, we've addressed SOAP headers as a means for vertical extensibility within SOAP messages. There is another related notion, however: horizontal extensibility. Whereas vertical extensibility is about the ability to introduce new pieces of information within a SOAP message, horizontal extensibility is about targeting different parts of the same SOAP message to different recipients. Horizontal extensibility is provided by SOAP intermediaries.

The Need for Intermediaries

SOAP intermediaries are applications that can process parts of a SOAP message as it travels from its origination point to its final destination point. The route taken by a SOAP message, including all intermediaries it passes through, is called the SOAP message path (see Figure 3.2).

Figure 3.2Figure 3.2 The SOAP message path

Intermediaries can both accept and forward SOAP messages, and they usually do some form of message processing as well. Three key use-cases define the need for SOAP intermediaries: crossing trust domains, ensuring scalability, and providing value-added services along the SOAP message path.

Crossing trust domains is a common issue faced while implementing security in distributed systems. Consider the relation between a corporate or departmental network and the Internet. For small organizations, it's likely that the IT department has put most computers on the network within a single trusted security domain. Employees can see their co-workers' computers as well as the IT servers, and they can freely exchange information between them without the need for separate logons. On the other hand, the corporate network probably treats all computers on the Internet as part of a separate security domain that isn't trusted. Before an Internet request reaches the network, it needs to cross from its untrustworthy domain to the trusted domain of the internal network. Corporate firewalls and virtual private network (VPN) gateways guard the network: Their job is to let some requests cross the trust domain boundary and deny access to others.

Another important need for intermediaries arises because of the scalability requirements of distributed systems. A simplistic view of distributed systems could identify two types of entities: those that request work to be done (clients) and those that do the work (servers). Clients send messages directly to the servers they want to communicate with. Servers, in turn, get some work done and respond. In this naïve universe, there is little need for distributed computing infrastructure. However, we can't use this model to build highly scalable distributed systems.

Take email as an example. When someone@company.com sends an email message to myfriend@london.co.uk, it's not the case that their email client locates the mail server london.co.uk and sends the message to it. Instead, the client sends the message to its email server at company.com. Based on the priority of the message and how busy the mail server is, the message will leave either by itself or in a batch of other messages. (Messages are often batched to improve performance.) The message will probably make a few hops through different nodes on the Internet before it gets to the mail server in London.

The lesson from this example is that highly scalable distributed systems (such as email) require flexible buffering of messages and routing based both on message parameters such as origin, destination, and priority, and on the state of the system considering factors such as the availability and load of its nodes as well as network traffic information. Intermediaries hidden from the eyes of the originators and final recipients of messages can perform this work behind the scenes.

Finally, we need intermediaries so that we can provide value-added services in a distributed system. The type of services can vary significantly, and some of them involve the message sender being explicitly aware of the intermediary, unlike our previous examples. Here are a couple of common scenarios:

  • Securing message exchanges, particularly through untrustworthy domains—You could secure SOAP messages by passing them through an intermediary that first encrypts them and then digitally signs them. On the receiving side an intermediary would perform the inverse operations: checking the digital signature and, if it's valid, decrypting the message.

  • Notarization/nonrepudiation—when the sender or receiver (or both) desires a third party to make a record of an interaction, a notarizing intermediary is a likely solution. Instead of sending the message directly to the receiver, the sender sends to the intermediary, who makes a persistent copy of the request and then sends it to the service provider. The response typically comes back via the intermediary as well, and then both parties are usually given a token they can use to reference the transaction record in the future.

  • Providing message tracing facilities—Tracing allows the message recipient to find out the path the message followed, complete with detailed timings of arrivals and departures to and from intermediaries. This information is indispensable for tasks such as measuring quality of service (QoS), auditing systems, and identifying scalability bottlenecks.

Transparent and Explicit Intermediaries

Message senders may or may not be aware of intermediaries in the message path. A transparent intermediary is one the client knows nothing about—the client believes it's sending messages to the actual service endpoint, and the fact that an intermediary is doing work in the middle is incidental. An explicit intermediary, on the other hand, involves specific knowledge on the part of the client—the client knows the message will travel through an intermediary before continuing to its ultimate destination.

The security intermediaries discussed earlier would likely be transparent; the organization providing the service would publish the outward-facing address of the intermediary as the service endpoint. The notarization service described earlier would be an example of an explicit intermediary—the client would know that a notarization step was going on.

Intermediaries in SOAP

SOAP is specifically designed with intermediaries in mind. It has simple yet flexible facilities that address the three key aspects of an intermediary-enabled architecture:

  • How do you pass information to intermediaries?

  • How do you identify who should process what?

  • What happens to information that is processed by intermediaries?

All header elements can optionally have the soapenv:role attribute. The value of this attribute is a URI that identifies who should handle the header entry. Essentially, that URI is the name of the intermediary. This URI might mean a particular node (for instance "the Solaris machine on John's desk"), or it might refer to a class of nodes (as in, "any cache manager along the message path"). (This latter case prompted the name change from actor to role in SOAP 1.2.) Also, a given node can play multiple roles: the Solaris machine on John's desk might also be a cache manager, for instance, so it would recognize either role URI.

The first step any node takes when processing a SOAP message is to collect all the headers that are targeted at the node—this means headers that have a role g attribute matching any of the roles node is playing. It then looks through these nodes for headers marked mustUnderstand and confirms that it recognizes each such header and is able to process it in accordance with the rules associated with that SOAP header. If it finds a mustUnderstand header that it doesn't recognize, it must immediately stop processing.

There are several special values for the role attribute:

  • http://www.w3.org/2003/05/soap-envelope/role/next—Indicates that the header entry's recipient is the next SOAP node that processes the message. This is useful for hop-by-hop processing required, for example, by message tracing.

  • http://www.w3.org/2003/05/soap-envelope/role/ultimateReceiver—Refers to the final recipient of the SOAP message. Note that omitting the role attribute or using an empty value ("") also implies that the final recipient of the SOAP message should process the header entry. The final recipient of the SOAP message is the same node that processes the body.

  • http://www.w3.org/2003/05/soap-envelope/role/none—A special role that no SOAP node should ever assume. That means that headers addressed to this role should never be processed; and since no one will ever be in this role, the value of the mustUnderstand attribute won't matter for such headers (remember that the first thing a SOAP node does is pick out the headers it can see by virtue of playing the right role, before looking at mustUnderstand). Also note that the relay attribute (discussed later) never matters on a header addressed to the none role, for the same reason. Even though your SOAP node can't act as the none role, it can still look at the data inside headers marked as none. So, headers marked for the none role can still be used to carry data. (We'll give an example in a bit.)

SOAP 1.1 Difference: actor versus role

In SOAP 1.1, the attribute used to target headers is called actor, not role. Also, SOAP 1.1 only specifies a special next actor URI (http://schemas.xmlsoap.org/soap/actor/next), not an actor for none or ultimateRecipient.

Forwarding and Active Intermediaries

Some intermediaries, like the notarization example discussed earlier, only do processing related to particular headers in the SOAP envelope before forwarding the message to the next node in the message path. In other words, the work of the intermediary is defined by the contents of the incoming messages. These are known as forwarding intermediaries.

Other intermediaries do processing and potentially modify the message in ways not defined by the message contents. For instance, an intermediary at a company boundary to the outside world might add a digital signature header to every outbound message to ensure that receivers can check the integrity of all messages. No explicit markers in the messages are used to trigger this behavior; the node simply does it. This type of intermediary is known as an active intermediary.

Either type of intermediary may do arbitrary work on the message (including the body) based on its internal rules.

Rules for Intermediaries and Headers

By default, all headers targeted at a particular intermediary are removed from the message when it's forwarded on to the next node. This is because the specification tells us that the contract implied by a given header is between the sender of that header and the first node satisfying the role at which it's targeted. Headers that aren't targeted at a particular intermediary should, in general, be forwarded through untouched (see Figure 3.3).

An intermediary removes headers targeted at any role it's playing, regardless of whether they're understood. In Figure 3.4, one header is processed and then removed; another isn't understood, but because it's targeted at our intermediary and not marked mustUnderstand, it's still removed.

Figure 3.3Figure 3.3 Intermediary header removal

Figure 3.4Figure 3.4 Removing optional headers targeted at an intermediary

There are two exceptions to the removal rules. First, the specification for a particular extension may explicitly indicate that an identical copy of a given header from the incoming message is supposed to be placed in the outgoing message. Such headers are known as reinserted, and this has the effect of forwarding them through after processing. An example might be a logging extension targeted at a logManager. Any log manager receiving it along the message path would make a persistent copy of the message for logging purposes and then reinsert the header so that other log managers later in the chain could do the same.

The second exception is when you want to indicate to intermediaries that extensions targeted at them, but not understood, should still be passed through. SOAP 1.2 introduces the relay attribute for this purpose. If the relay attribute is present on a header which is targeted at a given intermediary, and it has the value true, the intermediary should forward the header regardless of whether it understands it. Figure 3.5 shows an unknown header arriving at our notary intermediary. Since all nodes must recognize the next role, the unknown header is targeted at the intermediary. Despite the fact that the intermediary doesn't understand the header, it's forwarded because the relay attribute is true.

Figure 3.5Figure 3.5 Forwarding headers with the relay attribute



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