XML Web Services: Just Another Data Tier?

XML Web Services: Just Another Data Tier?

ost developers are now quite comfortable developing XML Web services. Visual Studio has a project template to create a new Web service project, but you don’t need to create a separate project; you can add an XML Web service to any existing Web application developed in .NET. To do that, right-click on the project item in the Solution Explorer and select the “Add Web Reference” item from the popup menu. Enter the URL of the Web service into the Address field at the top of the Add Web Reference dialog. Visual Studio automatically creates the files required to use the Web service and adds them to your project. After you add a Web reference, you’ll see the Web service appear in the Solution Explorer, similar to the project shown in Figure 1.

Figure 1: This sample project has a default page (default.aspx) and an XML Web service (api.asmx).

As a real-world example, Amazon’s Web services (AWS) give other Web sites and desktop applications access to Amazon’s lists of books, CDs etc., and let them use Amazon’s search engine to search for items using specified query parameters. Amazon has essentially outsourced Web page development by providing Web services to the partner Web sites.

The gist of this article is that you can offer Web services to friendly developers, and use the same code to populate your own Web site.

Create a Web Service
When you create an XML Web service, you make the service publicly available by creating a file with the extension asmx. For example, the sample project contains a Web service file called api.asmx. The asmx files themselves usually contain little code, just a reference to a code-behind module and a class in that module. In the sample project the code-behind class is called “api.”

When you create a new Web service in Visual Studio, the Web service template generates the asmx file and a code-behind module automatically. The code-behind module contains a sample function decorated with the attribute and named HelloWorld . The function simply returns a string.

    Public Function HelloWorld() As String      return "Hello World"   End Function 

There have been a number of good articles on DevX about using attributes, so I won’t repeat them here; it’s sufficient to say that the WebMethod attribute instructs the ASP.NET runtime to build a SOAP interface around the class and also causes it to generate the sample pages seen when you navigate to the Web service in your browser. You can find the HelloWorld function in the api class in the sample project. The api class inherits from System.Web.Services.WebService.

The point to note here is that adding the WebMethod attribute to a method doesn’t prevent you from using it in other ways. For example, you can still call the HelloWorld method from your own Web pages in the usual way?by creating an instance of the api class, calling the function, and assigning the return value to a server-side label. If you have downloaded the sample project and set the startup document to default.aspx, compile and run the project to see the results, which look like Figure 2.

Figure 2: The default.aspx file looks like this when loaded into a browser.

To provide some benchmarks, the page contains some quick and dirty performance counter code that displays the elapsed times for the method calls.

Caching Web Services
In addition to the simplistic HelloWorld Web service, the class exposes a second Web service called ListCurrencies, which loads the XML file currency.xml into a DataSet, and returns the result. Here’s the method code:

    _   Public Function ListCurrencies() As DataSet      Dim ds As New DataSet("CurrencyList")      ds.ReadXml(Server.MapPath("currency.xml"))      Return ds   End Function

In the section of the Web Form marked “Example 2”, the Button2_click event handler code creates an instance of the Web service as an ordinary class, and sets the DataSource property of the control Dropdownlist1 to the result of the ListCurrencies method. So when you click the “ListCurrencies” button the page calls the ListCurrencies method and populates the dropdown list (see Figure 3).

Figure 3: When you click the “ListCurrencies” button, the page calls the ListCurrencies method and populates the drop-down list.

Because any code that you run repeatedly consumes server resources, always consider caching the output when possible. The output of the ListCurrenciesCached method exposed by the api class illustrates how you can cache Web services. The api class inherits System.Web.Services.WebService, so it automatically “knows” about the current Context. The HttpContext class exposes a Cache property that returns an instance of a useful, high performance caching class that can hold objects in memory and retrieve them using simple name-value pairs?just as you use the HttpApplication object to store global data such as database connection strings or mail server information.

The difference between using the Cache object and the Application object is that you can tell the HttpContext.Cache to invalidate specific cached items on a regular schedule, at a specific time, or whenever a file changes. The code below checks to see if there is an object already in the cache with the key “CurrencyList”. If there is, the code casts the cached object back to a DataSet and returns it. If the object isn’t in the cache, the code calls the ListCurrencies method to obtain the DataSet, and then places the result in the cache using a file dependency. If any process updates the file while the data is cached, the cache flushes the object during the next request, and replaces it with the new data.

   Public Function listCurrenciesCached() As DataSet   If Not Context.Cache("CurrencyList") Is Nothing Then      Return CType(Context.Cache("CurrencyList"), _         DataSet)   Else        Dim CurFile As String = _         Server.MapPath("currency.xml")      Dim ds As New DataSet()      ds = ListCurrencies()      Context.Cache.Insert("CurrencyList", ds, _         New System.Web.Caching.CacheDependency _            (CurFile), _         Now.AddHours(1), Nothing)      Return ds   End If

The Web service is the “right” tier in which to do this caching?it is on the web server, in front of the Business Logic and Data Access code, but still available to any web page / User Interface that wants to use it.

Although this example is trivial the concept applies equally well to more complicated scenarios. Consider a case where you want to provide such a list based on the contents of a database table whose contents may change on a daily basis as new product lines are added. You would not want to query the database every time someone visits the page. You could arrange for the database to write an xml file whenever someone updates the table (The SQL Server web wizard makes this trivial) and then the above method would always present up-to date information, while the load on the database is hugely reduced.

For a shop site, while you would probably not put your entire product catalog into the cache, you might cache a subset of the product tables, perhaps “Department,” “Aisle,” and “Shelf,” and then select from the database depending on the cached “DepartmentID,” “AisleID,” and “ShelfID” values.

Reusing Web Service Code
Here’s another example of using Web services in both local and remote mode.

In a hypothetical online book store, it’s logical to provide “search by author” (see Figure 4) functionality both within the site and externally?and it’s not logical to write the search functionality twice.

Figure 4: The sample application exposes a Web service that lists books by author.

The page in Figure 4 uses the api class’ ListBooksByAuthor method, which accepts an author’s name as input and returns a DataSet. The DataSet format matches Amazon’s Web service description (WSDL) because I used their Web service to get some real world data. You can find the XML document containing the data for that DataSet in the sample project as the file petzold.xml. The Web Form Authors.aspx contains a populateGrid() function which creates an instance of the api class, and then sets the DataSource property of a grid control to the result of the ListBooksByAuthor() method, thus binding the grid to the DataSet.

   Private Sub PopulateGrid()      Dim oSearch As New api()      With DataGrid1         .DataSource = oSearch.listBooksByAuthor _            ("Charles Petzold").Tables("Details")         .DataBind()      End With   End Sub 

When you click the button labeled “Books by Charles Petzold,” the page sets the grid’s DataSource property to the PopulateGrid method, which populates the grid with exactly the same data as external partners see by using the Web service (see Figure 5). Of course, making both internal and external (Web service) method results identical may not always be what you want. You can easily tailor the result by including a required partner ID parameter in the Web service method call, letting you differentiate between internal and external callers.

Figure 5: The Web service listBooksByAuthor returns the same dataset whether you run it as a local method or as a Web service.

By presenting and consuming your own search, list, and other methods as both local methods that your application uses, and as XML Web services, other sites can use those services to present data on your behalf?and you don’t have to do any extra work to make that happen. Better yet, you can add new functionality without having to maintain code in two places.

devx-admin

devx-admin

Share the Post:
Development Project

Thrilling East Windsor Mixed-Use Development

Real estate developer James Cormier, in collaboration with a partnership, has purchased 137 acres of land in Connecticut for $1.15 million with the intention of

USA Companies

Top Software Development Companies in USA

Navigating the tech landscape to find the right partner is crucial yet challenging. This article offers a comparative glimpse into the top software development companies

Software Development

Top Software Development Companies

Looking for the best in software development? Our list of Top Software Development Companies is your gateway to finding the right tech partner. Dive in

India Web Development

Top Web Development Companies in India

In the digital race, the right web development partner is your winning edge. Dive into our curated list of top web development companies in India,

USA Web Development

Top Web Development Companies in USA

Looking for the best web development companies in the USA? We’ve got you covered! Check out our top 10 picks to find the right partner

Clean Energy Adoption

Inside Michigan’s Clean Energy Revolution

Democratic state legislators in Michigan continue to discuss and debate clean energy legislation in the hopes of establishing a comprehensive clean energy strategy for the

Development Project

Thrilling East Windsor Mixed-Use Development

Real estate developer James Cormier, in collaboration with a partnership, has purchased 137 acres of land in Connecticut for $1.15 million with the intention of constructing residential and commercial buildings.

USA Companies

Top Software Development Companies in USA

Navigating the tech landscape to find the right partner is crucial yet challenging. This article offers a comparative glimpse into the top software development companies in the USA. Through a

Software Development

Top Software Development Companies

Looking for the best in software development? Our list of Top Software Development Companies is your gateway to finding the right tech partner. Dive in and explore the leaders in

India Web Development

Top Web Development Companies in India

In the digital race, the right web development partner is your winning edge. Dive into our curated list of top web development companies in India, and kickstart your journey to

USA Web Development

Top Web Development Companies in USA

Looking for the best web development companies in the USA? We’ve got you covered! Check out our top 10 picks to find the right partner for your online project. Your

Clean Energy Adoption

Inside Michigan’s Clean Energy Revolution

Democratic state legislators in Michigan continue to discuss and debate clean energy legislation in the hopes of establishing a comprehensive clean energy strategy for the state. A Senate committee meeting

Chips Act Revolution

European Chips Act: What is it?

In response to the intensifying worldwide technology competition, Europe has unveiled the long-awaited European Chips Act. This daring legislative proposal aims to fortify Europe’s semiconductor supply chain and enhance its

Revolutionized Low-Code

You Should Use Low-Code Platforms for Apps

As the demand for rapid software development increases, low-code platforms have emerged as a popular choice among developers for their ability to build applications with minimal coding. These platforms not

Cybersecurity Strategy

Five Powerful Strategies to Bolster Your Cybersecurity

In today’s increasingly digital landscape, businesses of all sizes must prioritize cyber security measures to defend against potential dangers. Cyber security professionals suggest five simple technological strategies to help companies

Global Layoffs

Tech Layoffs Are Getting Worse Globally

Since the start of 2023, the global technology sector has experienced a significant rise in layoffs, with over 236,000 workers being let go by 1,019 tech firms, as per data

Huawei Electric Dazzle

Huawei Dazzles with Electric Vehicles and Wireless Earbuds

During a prominent unveiling event, Huawei, the Chinese telecommunications powerhouse, kept quiet about its enigmatic new 5G phone and alleged cutting-edge chip development. Instead, Huawei astounded the audience by presenting

Cybersecurity Banking Revolution

Digital Banking Needs Cybersecurity

The banking, financial, and insurance (BFSI) sectors are pioneers in digital transformation, using web applications and application programming interfaces (APIs) to provide seamless services to customers around the world. Rising

FinTech Leadership

Terry Clune’s Fintech Empire

Over the past 30 years, Terry Clune has built a remarkable business empire, with CluneTech at the helm. The CEO and Founder has successfully created eight fintech firms, attracting renowned

The Role Of AI Within A Web Design Agency?

In the digital age, the role of Artificial Intelligence (AI) in web design is rapidly evolving, transitioning from a futuristic concept to practical tools used in design, coding, content writing

Generative AI Revolution

Is Generative AI the Next Internet?

The increasing demand for Generative AI models has led to a surge in its adoption across diverse sectors, with healthcare, automotive, and financial services being among the top beneficiaries. These

Microsoft Laptop

The New Surface Laptop Studio 2 Is Nuts

The Surface Laptop Studio 2 is a dynamic and robust all-in-one laptop designed for creators and professionals alike. It features a 14.4″ touchscreen and a cutting-edge design that is over

5G Innovations

GPU-Accelerated 5G in Japan

NTT DOCOMO, a global telecommunications giant, is set to break new ground in the industry as it prepares to launch a GPU-accelerated 5G network in Japan. This innovative approach will

AI Ethics

AI Journalism: Balancing Integrity and Innovation

An op-ed, produced using Microsoft’s Bing Chat AI software, recently appeared in the St. Louis Post-Dispatch, discussing the potential concerns surrounding the employment of artificial intelligence (AI) in journalism. These

Savings Extravaganza

Big Deal Days Extravaganza

The highly awaited Big Deal Days event for October 2023 is nearly here, scheduled for the 10th and 11th. Similar to the previous year, this autumn sale has already created

Cisco Splunk Deal

Cisco Splunk Deal Sparks Tech Acquisition Frenzy

Cisco’s recent massive purchase of Splunk, an AI-powered cybersecurity firm, for $28 billion signals a potential boost in tech deals after a year of subdued mergers and acquisitions in the

Iran Drone Expansion

Iran’s Jet-Propelled Drone Reshapes Power Balance

Iran has recently unveiled a jet-propelled variant of its Shahed series drone, marking a significant advancement in the nation’s drone technology. The new drone is poised to reshape the regional

Solar Geoengineering

Did the Overshoot Commission Shoot Down Geoengineering?

The Overshoot Commission has recently released a comprehensive report that discusses the controversial topic of Solar Geoengineering, also known as Solar Radiation Modification (SRM). The Commission’s primary objective is to

Remote Learning

Revolutionizing Remote Learning for Success

School districts are preparing to reveal a substantial technological upgrade designed to significantly improve remote learning experiences for both educators and students amid the ongoing pandemic. This major investment, which

Revolutionary SABERS Transforming

SABERS Batteries Transforming Industries

Scientists John Connell and Yi Lin from NASA’s Solid-state Architecture Batteries for Enhanced Rechargeability and Safety (SABERS) project are working on experimental solid-state battery packs that could dramatically change the