Home > Articles > Programming > Windows Programming

📄 Contents

  1. Common Language Runtime
  2. Core Classes
  3. NET
  4. A PriceCheck Client in .NET
  5. Exposing .NET Web Services: Package Tracking for SkatesTown
This chapter is from the book

Exposing .NET Web Services: Package Tracking for SkatesTown

Okay, so building clients in .NET is pretty simple. What about exposing services? Luckily, with ASP.NET, it's even easier. (For you Windows 98 folks out there, sorry—this section won't work for you. .NET's server-side components are strictly for Windows 2000 or later. If you want to try the example, please make sure that you install the .NET server side components plus all prerequisites.)

Let's bring our attention back to SkatesTown for a minute for this example. For some months now, SkatesTown has been using ShipIt, Inc., to send its packages. All the shipping has happened behind the scenes, but some customers have (quite reasonably) been asking for the ability to get tracking numbers for their shipments. We'll walk you through a simple version of what ShipIt might do on its .NET-based system to provide this feature to SkatesTown.

We'll simulate the package-tracking application in .NET by building an .asmx file. As you'll see, ASMX files are a lot like JWS files—they allow you to drop source code into a regular old text file and have the ASP.NET framework automatically compile and execute the code for you on demand. There are some differences, though.

For one thing, all ASMX files require a WebService directive at the beginning of the file, which tells the infrastructure what language the source code is expressed in and the name of the class that implements the actual service. ASMX files can use any of the supported .NET languages for Web services (right now that's C#, Visual Basic, and Jscript).

Another difference is that ASMX files automatically support an HTTP GET and POST binding as well as access via SOAP. This means that you can call an ASMX-based Web service with just a browser, passing arguments as query string parameters or form fields. Of course, this doesn't allow for the kind of rich data mapping you can do with XML, but it is handy for services that only deal in simple types.

Let's take a look at a simple service implemented as an ASMX file; see Listing 1. This service does two things. First, it generates new tracking numbers, which tie to instances of a PackageInfo class. Second, it returns a tracking report for an existing tracking number. (This example is not a real simulation of the situation—it has been vastly simplified to let us focus more on the Web service infrastructure and less on the application logic.)

Listing 1: C# Package Tracking Service in .NET

<%@ WebService Language="C#" Class="ShipIt.PackageService" %>

using System.Collections;
using System.Web.Services;
using System.Web.Services.Protocols;

namespace ShipIt {
  // Here's the "PackageInfo" class which represents
  // a package in transit.
  //
  public class PackageInfo {
    static int maxHops = 4;
    int hop = 1;
    
    int trackingNumber;
    
    string currentReport;
    
    public PackageInfo(int id)
    {
      trackingNumber = id;
      currentReport = "<h2>Tracking Report<h2> <ul>";
    }
    
     // Move a package one hop and update its
     // tracking log. Don't bother if it has
     // reached its destination.
    public void movePackage() {
      if (hop < maxHops) {
        currentReport += "<li>Arrived at hop #" + hop + "\n";
        hop++;
      } else if (hop == maxHops) {
        currentReport += "<li>Delivered!\n";
        hop++;
      }
    }
    
    public string getTrackingReport() {
      return currentReport + "</ul>";
    }
  }
  
  [WebService(Namepace="http://BWS-ShipIt.com/")]
   // This is a SOAP RPC service
  [SoapRpcService]
  public class PackageService : WebService {

    static int lastTrackingNumber = 1;
    static Hashtable trackedPackages = new Hashtable();

    [WebMethod]
    public int getTrackingNumber() {
      PackageInfo pi = new PackageInfo(lastTrackingNumber);
      trackedPackages.Add(lastTrackingNumber, pi);
      return lastTrackingNumber++;
    }
    
    [WebMethod]
    public string getTrackingReport(int trackingNumber) {
      PackageInfo pi =
       (PackageInfo)trackedPackages[trackingNumber];
      if (pi != null) {
         // For the sake of example, we move the package
         // one "step" each time this is called.
        pi.movePackage();
        return pi.getTrackingReport();
      }
      return "No such tracking number!";
    }
  }
}

We have a C# class; this is nothing new. But the text in the square brackets ([]) is different; these directives tell the runtime any metainformation that we need to convey. In this case, we're marking each method that we would like to publish as a [WebMethod]. This tells the runtime that the marked methods are accessible via Web service interfaces from outside and should be included in a WSDL description of the service. There is also a [SoapRPCService] directive at the top of the class. It indicates that our class is a SOAP service that uses section 5–encoded payloads and the SOAP RPC style. By default, all .NET services are document-oriented and use literal encoding. The [WebService] directive just above that one allows us to specify the namespace of the service (this will be the namespace of the body elements for the service requests and responses).

The getTrackingNumber() method creates a PackageInfo object and inserts that PackageInfo into a hashtable, indexed by an integer tracking number that we return to the user.

When generateTrackingReport() is called, we first look up the PackageInfo that was previously stored. Then, for the purposes of this simple example, we call movePackage() to move the package one hop along the path to its destination. Clearly, in the real world, getting a tracking report for a package does not actually move it closer to its destination (much as we might wish otherwise), but this is a quick and easy way for us to simulate movement. Once the PackageInfo has been moved, we simply return the tracking report generated by the PackageInfo class.

To deploy this service, just drop it into your Web hierarchy. For our purposes, we've put it in Inetpub\wwwroot\shipit\PackageService.asmx. Figure 2 shows what happens if we hit it with a browser.

Figure 2 Browser view of .NET Package service URL.

This page is automatically generated for us by .NET, and it allows us to not only see what methods are available, but also to actually test the methods in the browser. You can try this out by clicking the method names to get a page that looks like Figure 3.

Figure 3 Expanded view of the getTrackingReport method.

You'll find the source code to this service in the dotnet/ directory of the examples. If you deploy this service to the location shipIt/PackageService.asmx on your machine (in other words, drop the file in IIS under wwwroot/shipIt/packageService.asmx), you'll be able to try an example that integrates this service into SkatesTown's order processing system. Just bring up the modified order page, submit the request, and you'll get a package tracking number along with your invoice (see Figure 4). Clicking the tracking link will get you a package tracking report.

Figure 4 PO results with package tracking.

We encourage you to examine the Java source for the tracking page (track.jsp) to see how this works; as usual, we've just got a JSP front end that calls a remote Web service. The only difference is that, for this one, the service is provided by .NET—interoperability in action!

The modified POSubmissionClient class is also worth a look; it works exactly the same way as we've traditionally been writing this class for our examples—in particular, it doesn't expect the SOAP body (the returned invoice) to change in order to carry the tracking number. Rather, we do that by introducing a SOAP header that is plucked out by the client.

The header is produced by a modified version of the POSubmission service—TrackingSubmission.java, which you'll find in com/skatestown/services alongside the normal POSubmission class.

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