Home > Articles > Web Services > XML

This chapter is from the book

This chapter is from the book

Publishing Enduring Web Services Contracts

A web service contract, usually expressed via a WSDL, describes the relationship between the web services that you publish and the manner in which an external client can interact with them. These touch upon what XML messages to expect, what business operations you can perform, and what XML messages you generate. You can do so without letting the other party know about the technical details of your application and how they change over time. By the same token, you can use other developers' public contracts to consume their applications without needing to know the details or even the language and platform they use to implement their web service.

These contracts can be made more durable by following certain principles, such as loose coupling, XML strategy selection, and versioning.

Integrating Through Loose Coupling

An important aspect of web services design is to ensure that the web services are loosely coupled. Web services are loosely coupled when you separate the internal implementation from the interface exposed to the user of your service. The web service has an interface defined by the WSDL that is exposed to the outside world. The internal implementation of a web service is the specific application server that it runs on or the EJBs that do the business logic. If you need to change your application server, the user of the service is not affected because there is a change only to the internal implementation. When this is ensured, the user of the web service does not need to get involved in testing changes unless the interface changes as defined by the WSDL. You might still want to test with the client even if the WSDL doesn't change, to make sure that SLAs and performance requirements can still be met.

Using the WSDL, however, is not enough to guarantee loose coupling. If your WSDL is automatically generated from the code and you change the code, the WSDL changes, thus making it tightly coupled to the code. WebLogic Workshop provides XQuery Maps which is a simple, declarative way of describing how your Java code relates to the WSDL of your web service. If your Java code changes over time, you can change your XQuery Map so that your WSDL stays intact. XQuery Map maps the Java code to your WSDL. When the Java code changes, the mapping can be alerted to keep the WSDL the same. This enables you to truly realize the promise of loose coupling. WebLogic also provides the facility of modeling the WSDL in XMLSpy and then importing it into WebLogic Workshop. With this WSDL, you can create a web service in WebLogic Workshop. See Figures 5.2 and 5.3 for an illustration of the modeling and importing of WSDL.

Figure 5.2Figure 5.2 Modeling of WSDL

Figure 5.3Figure 5.3 Importing of WSDL in WebLogic Workshop

Here is an example of using an XQuery map in WebLogic Workshop. The start and end of the XML map is shown by the annotation:

 * @jws:operation
 * @jws:parameter-xml xml-map::
 *  < order>
 * <item xm:multiple="String name in nameA,
int amount in amountA, float price in priceA"> * <name>{name}</name> * <amount>{amount}</amount> * <price>{price}</price> * </item> * </order> * :: * @jws:return-xml xml-map:: * <totalPrice>{return}</totalPrice> * :: */ public float getTotalPrice(String [] nameA,
int [] amountA, float [] priceA) { float totalPrice = 0.0f; if( nameArr != null ) { // for each item, compute subtotal and add to total for (int i = 0; i < nameArr.length; i++) { totalPrice += amountArr[i] * priceArr[i]; } } return totalPrice; }

This map specifies that the getTotalPrice Java method receives an XML document that contains an order with multiple line items, each with a name, amount, and price. These fields are extracted from the XML message and mapped into Java arrays. Similarly, the float value that is returned from the method is placed in the context of a simple XML document that has a <totalPrice> tag.

Choosing an XML Strategy

XML is the messaging standard for web services. You have to choose the right strategy for handling XML messages in web services, depending on how the web services you are designing fit into the overall application.

The XML strategy that you will use depends on two criteria. One is whether you have any application logic and whether you are exposing the application logic. The second criterion is whether the interface to the web service you are developing has a predefined XML Schema and whether you want to define your own.

This can lead to four different strategies for handling XML Schemas:

  • Defined application logic and predefined XML Schema—In this case, the strategy that you use is mapping between defined incoming messages to fields in your internal data types. XQuery maps in WebLogic Workshop can be used to map the data.

  • No internal classes and predefined XML Schema—If schemas are defined in the WSDL file, you should import the WSDL in WebLogic Workshop and let XML Beans accept the schema file and return a set of Java classes that a developer can conveniently leverage to process any XML document that conforms to the original schema file. Having schema definitions at the core of the XML Beans system provides a variety of benefits. For example, when you first receive an XML document for processing, you can validate the data based on the schema definition. Any time you manipulate the XML document via the schema-inspired Java classes, the XML Beans system can always ensure that all changes remain consistent with the prevailing schema definition. This unambiguously disallows the creation of invalid XML documents.

  • When internal classes are defined and the schema is not defined, you should define your schema according to your internal classes. If both are not defined, first define the schemas and then derive the Java classes from there. This follows the concept of designing WSDL first, as described in the earlier section.

Versioning New Releases

You need to consider versioning of your web service to facilitate managing multiple versions of a web service. Versioning should minimize code replication and maximize code reuse. It should also put a logical and manageable naming paradigm in place. This allows for upgrades and improvements to be made to existing web services, while continuously supporting previously released versions of that web service.

Two areas should be considered for versioning a web service: the public interface, as described by the WSDL file, and the web service implementation, including its conversational state.

Versioning the Public Interface

You can version the public interface—specifically, your WSDL—in different ways:

  • Use a different endpoint for your service:

<wsdl:service name="Validate_v1_2">
    <wsdl:port name="Validate" binding="tns1:ValidateSoapBinding">
      <wsdlsoap:address location="localhost:7001/ValidateConfigNewWeb/
ValidateConfigNew/validate_v1_2ControlTest.jws"/> </wsdl:port> </wsdl:service>

In this example, you can change to the next version validate_v1_3 by changing the address of the endpoint for the service as follows:

<wsdlsoap:address location="localhost:7001/ValidateConfigNewWeb
/ValidateConfigNew/validatev_1_3ControlTest.jws"/>

In this approach, the XML Schema does not change and there is no change in your SOAP message. The advantage in this option is that you can insulate your users from changing schemas. The drawback is that there is no reference to the version validate_v1_2 within the SOAP message, so you cannot use management tools that can direct the message to the right version:

<SOAP-ENV:Body>
    <m:inValidateConfig xmlns:m="http://production.psg.hp.com/types">
      ...
  </SOAP-ENV:Body>
  • Use a date stamp as part of the target namespace of your XML Schema. This is in compliance with the W3C XML Schema specification. The disadvantage here is that your schema changes every time the version changes. The advantage of this approach is that you can see the version in your SOAP messages, and you can write code or use management tools to direct the web service to the right version, according to the SOAP message:

<SOAP-ENV:Body>
    <m:inValidateConfigv1_2
xmlns:m="http://production.psg.hp.com/types/2004/02/04"> ... </SOAP-ENV:Body>
  • Add new operations to the WSDL and support old ones until the user moves to the new operation. You can add new operations to the public interface of a web service to reflect the new versions, keeping the existing operations. The advantage of doing so is that you do not disrupt clients that rely on the web service. By adding new operations and making them known to clients, you can gradually shift clients over to a new set of operations, but you should leave the original operations intact for backward compatibility. For example, the operation section of the WSDL will look as shown here:

<wsdl:operation name="validateConfig">
    <wsdlsoap:operation soapAction="validate_v1_2"/>
    <wsdl:input>
      <wsdlsoap:body use="literal"/>
    </wsdl:input>
    <wsdl:output>
      <wsdlsoap:body use="literal"/>
    </wsdl:output>
  </wsdl:operation>
  <wsdl:operation name="validatePrice">
    <wsdlsoap:operation soapAction=" validate_v1_3 "/>
    <output>
      <wsdlsoap:body use="literal"/>
    </output>
    <input>
      <wsdlsoap:body use="literal"/>
    </input>
  </wsdl:operation>

The types section of the WSDL will look as shown here:

<wsdl:types>
    <xsd:schema targetNamespace="http://production.psg.hp.com/types"
xmlns="http://production.psg.hp.com/types" elementFormDefault="qualified"> <xsd:include schemaLocation="ValidateConfigv1_2.xsd"/> <xsd:include schemaLocation="ValidateConfigv1_3.xsd"/> </xsd:schema> </wsdl:types>

The SOAP message for each of the operations will look as shown next. Again, you can use management tools to direct messages to different versions:

<SOAP-ENV:Body>
    <m:inValidateConfigv1_2 xmlns:m="http://production.psg.hp.com/types">
      ...
  </SOAP-ENV:Body>
<SOAP-ENV:Body>
    <m:inValidateConfigv1_3 xmlns:m="http://production.psg.hp.com/types">
      ...
  </SOAP-ENV:Body>
  • Use UDDI and versioning UDDI in conjunction with WSDL to provide for versioning. The UDDI data model is rich enough that the current best practices can be enhanced to include service versioning. A given service can advertise more than one interface that represents its different versions. Different interfaces have different tModels. The service can reference the tModel for each of the interface in its tModelInstanceDetails collection. tModelInstanceDetails is a class that has tModelKey as a mandatory attribute.

Versioning the Implementation

WebLogic Workshop uses Java serialization to persist the state associated with web service requests and conversations. For this reason, the primary requirement for supporting versioned implementations is maintaining backward serialization compatibility. Specifically, it must be possible to load state into the current version of a class that was stored using any older versions of that class.

Versioning Lifecycle

Understanding the versioning lifecycle will help you to implement the new versions of your web service and deprecate the older versions effectively. First, you need to put together a plan for the lifecycle of the web services you are supporting. The main aspects of the plan of the versioning lifecycle are listed here:

  1. Your plan should contain the frequency of the release of your versions. For example, you could release one version per year. Consider how many versions of the web service you want to support in parallel.

  2. The plan should also contain the time frame for your users to move to the new version. This would be the same as the time you would support an older version after the new one is released.

  3. Consider using a pilot for the new version of the web services with an early release of version.

  4. Consider releasing new functionality and conformance to new web service specifications only through this versioning strategy, as with software releases.

  5. Communicate the versioning strategy to the users of your web service.

After you lay out the versioning strategy for each version, follow these steps to release each version of your web service:

  1. Make changes to the services that you are supporting, as detailed in the previous sections.

  2. Do unit and functional testing of the service.

  3. Deploy the new service either through new WSDLs for users of the service or to UDDI registries.

  4. Notify the consumers of your new service and pilot the new service with one of your consumers.

  5. Run the new and old versions in parallel for the time frame you have allocated in your versioning plan.

  6. Notify the consumers of the date when the old service is obsoleted.

  7. Remove the old service version from descriptions, registries, and so on to keep new consumers from discovering and using the old web service. Remove the functional behavior of the old service; return only an appropriate error message.

  8. Retire the old service. Physically remove the old service version.

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