ASP.NET Code
  Home arrow ASP.NET Code arrow Creating a Webservice Part 1 of 2
ASP Free Forums 
.NET  
ASP  
ASP Code  
ASP.NET  
ASP.NET Code  
BrainDump  
C#  
Code Examples  
Database  
Database Code  
IIS  
Microsoft Access  
MS SQL Server  
Silverlight  
Visual Basic.NET  
Windows Scripting  
Windows Security  
XML  
Mobile Linux 
App Generation ROI 
IBM® developerWorks 
ASP Web Hosting  
ASP.NET Web Hosting 
Windows Web Hosting
 
Weekly Newsletter
 
Developer Updates  
Free Website Content 
 RSS  Articles
 RSS  Forums
 RSS  All Feeds
Write For Us Get Paid 
Request Media Kit
Contact Us 
Site Map 
Privacy Policy 
Support 
 USERNAME
 
 PASSWORD
 
 
  >>> SIGN UP!  
  Lost Password? 
ASP.NET CODE

Creating a Webservice Part 1 of 2
By: Dave - 123aspx.com
  • Search For More Articles!
  • Disclaimer
  • Author Terms
  • Rating: 5 stars5 stars5 stars5 stars5 stars / 4
    2003-01-01

    Table of Contents:

    Rate this Article: Poor Best 
      ADD THIS ARTICLE TO:
      Del.ici.ous Digg
      Blink Simpy
      Google Spurl
      Y! MyWeb Furl
    Email Me Similar Content When Posted
    Add Developer Shed Article Feed To Your Site
    Email Article To Friend
    Print Version Of Article
    PDF Version Of Article
     
     
    ADVERTISEMENT



    Creating a Webservice

    With some help from the great guys from Secure Webs, I decided to expose my site, http://www.123aspx.com , as a web service. I wanted to start with something simple, so I decided to expose the "What's New" ASP.NET resources. The "what's new" section contains the latest 12 additions to my site. Here is a quick tutorial around writing that webservice.

    Webservices in ASP.NET are built around the SOAP (Simple Object Access Protocol) and WSDL (Web Services Description Language). We're not going to get into these standards (WSDL, and SOAP), but instead, focus on creating a webservice and consuming it.


    Planning

    I decided to return a dataset object as my collection of new resources. I chose a dataset because most ASP.NET developers are already familiar with datasets, and they can easily be bound to datagrids. The dataset consists of 4 columns:
    Name - the name or title of the resource.
    URL - The url to the resource
    Domain - The domain name the resource can be found at.
    DateUpdated - The date the resource was updated

    Layout

    We start programming a webservice by declaring it to the .NET engine and importing the following namespaces:
    <%@ WebService Language="VB" Class="AspX123WebSvc" %>
    Option Strict On
    Option Explicit On
    Imports System
    Imports System.Data
    Imports System.Data.SqlClient
    Imports System.Web
    Imports System.Web.Services
    Imports Microsoft.VisualBasic
    We also need to tell the compiler that the class "AspX123WebSvc" will be webservice enabled. We do this by inheriting the WebService namespace in the class declaration.
    Public Class AspX123WebSvc : Inherits WebService
    Now that we have our classes defined, I went ahead and declared the main function.

    Getting To It
    Because we are declaring a method here, we need to mark it as a webservice method using <webmethod()>
    Public Function GetNewResources() As DataSet
    I decided to add a friendly description to this method, to tell the consumer what this method does. When we view the default WSDL, supplied natively by ASP.NET, our description will show be available to the consuming programer. Once we have our functions and classes declared, writing a webservice is just like writing any other codebehind file.

    Accessing the Database
    Now that I have my webservice framework in place, let's go ahead and get our our data. In this example, I need to massage the data a little bit, specifically the domain name of the ASP.NET resource. So what I decided to do, was to return a datareader, strip off only the domain name of the resource (instead of returning the complete url), and then build the dataset that we will eventually be returning. To access the database I use 2 utility functions. One function is called GetDataReader( ) and the other function is called sqlConnString(). . GetDataReader() returns a SqlDataReader, it also takes advantage of System.Data.CommandBehavior.CloseConnection. System.Data.CommandBehavior.CloseConnection is a parameter that tells the framework to close the datareader as soon as I'm done reading from it. sqlConnString() is used to read my SQL Server connection string from the web.config file. I've included a snippet from my web.config file to display how I'm adding an appsettings section to web.config.
    GetDataReader()
    Private Function GetDataReader(sqlText as String) as SqlDataReader
    Dim dr as SqlDataReader
    Dim sqlConn as SqlConnection = new SqlConnection( sqlConnString() )
    Dim sqlCmd as SqlCommand = new SqlCommand( sqlText, sqlConn )

    sqlCmd.Connection.Open()
    dr = sqlCmd.ExecuteReader( System.Data.CommandBehavior.CloseConnection )

    Return dr
    End Function

    sqlConnString()
    Private Function sqlConnString() as String
    Return System.Configuration.ConfigurationSettings.AppSettings("WebSvcDb")
    End Function

    web.config
    <appSettings>
    <add key="WebSvcDb" value="Password=;User ID=sa;Initial Catalog=pubs;Data Source=127.0.0.1;" />
    </appSettings>

    Getting the Data
    I have a stored procedure called "s_res_whats_new". I execute the stored procedure to return the datareader. I also create my dataset that I will be passing back to the webservice.

    REM -- get the data from the database
    Dim sqlText as String = "exec s_res_whats_new"
    Dim dbRead as SqlDataReader = GetDataReader( sqlText )

    REM -- create the datatable
    Dim ds as DataSet = New DataSet("NewResources")
    Dim dt as DataTable = ds.Tables.Add("ResourceList")
    Dim dr as DataRow


    Assembling the DataSet
    Once I had a datareader back from my database, full of new resources, I loop through the datareader to create a dataset. The reason I didn't bring back the dataset directly, is because I needed to modify some of the data, before I sent it out as the webservice, mainly the Date and Domain name. I modify the date, to have a short date format, and I modify the url to only return the domain name part of the url. For example, if I was referencing the resource http://www.aspfree.com/authors/Default.asp, I only want to return www.aspfree.com. Once I have the parameters URL, DateUpdated, Domain, and Resource Name, I add them to a datarow and add the datarow to a datatable, which is part of the dataset. Here is the code I use to loop through the datareader and compile the dataset.

    REM -- get the data from the database
    Dim sqlText as String = "exec s_res_whats_new"
    Dim dbRead as SqlDataReader = GetDataReader( sqlText )

    REM -- create the datatable
    Dim ds as DataSet = New DataSet("NewResources")
    Dim dt as DataTable = ds.Tables.Add("ResourceList")
    Dim dr as DataRow

    while dbRead.Read()
    DateUpdated = DateTime.Parse(dbRead.Item("res_dateupdated").ToString())
    ResourceName = dbRead.Item("res_name").ToString()
    ResourceUrl = dbRead.Item("res_url").ToString()
    ResourcePk = dbRead.item("res_pk").ToString()

    ResourceDomain = ""
    If len(ResourceUrl)>PROT_PRFX_LEN then
    REM -- Strip off 'http://' and remove everything after .com, .net, or .org, or less than 25 characters
    UrlWhatsNew = ResourceUrl & "/"
    ResourceDomain = LCASE(Left(Mid(UrlWhatsNew, PROT_PRFX_LEN ,Instr(PROT_PRFX_LEN,UrlWhatsNew,"/")-PROT_PRFX_LEN),MAX_DOMAIN_LEN))
    End if
    ResourceDate = DateUpdated.ToShortDateString()
    ResourceUrl = "http://www.123aspx.com/resdetail.asp?rid=" & ResourcePk

    REM -- Add to DataSet ds
    dr = dt.NewRow()
    dr("URL") = ResourceUrl
    dr("DateUpdated") = ResourceDate
    dr("Domain") = ResourceDomain
    dr("Name") = ResourceName

    dt.Rows.Add(dr)
    End While

    Here I manipulated the "res_dateupdated" field by first converting it to a date. Because sql server is storing the date as a long date (mm/dd/yy with seconds), I needed to parse the date to return only mm/dd/yy. Creating a short date can be done by the following line:
    res_date = date_dateupdated.ToShortDateString()
    I added each local variable to a column in a datarow, and then added the row to the dataset. After the datareader had finished looping, I returned the Dataset.

    Testing
    Now it was time to test my webservice. ASP.NET provides a default page for testing webservices. If you look closely, you will see the description:"Returns the latest 12 New and Updated Resources at http://www.123aspx.com" that we used to describe our method GetNewResources.Here is a screenshot.

    ASP.NET returns a webservice in the form of the industry strandard, WSDL protocol. WSDL is an XML document that will tell the consumer what methods are available to be called, and can be considered a type of API. We can now test our webservice by clicking the Invoke button. Here is a screen shot of the first 3 rows of data that will be sent to the consumer.



    Conclusion
    ASP.NET makes it extremely easy for us to build webservices. Once we have a basic understanding of how ASP.NET works, it isn't that hard to extend our knowledge to webservices.


    DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware.

    More ASP.NET Code Articles
    More By Dave - 123aspx.com

     

    IBM® developerWorks developerWorks - FREE Tools!


    Build Forge Express demo: Enabling software delivery excellence for small and midsized businesses

    This demonstration gives you an overview of IBM® Rational® Build Forge Express Edition, a global offering that provides a framework to automate and execute software processes. Rational Build Forge provides a software assembly line that can support all of your tools, technologies, and platforms so you can achieve a repeatable, reliable, and traceable build and release process.
    FREE! Go There Now!


    NEW! Develop Systems Software Assets with IBM Rational Asset Manager

    Join us for this on demand webcast to learn about developing complex systems more quickly and efficiently. We'll cover market drivers for developing, governing and reusing systems software assets and how you can develop system software assets with Rational Asset Manager.
    FREE! Go There Now!


    NEW! Download DB2 Express-C 9.5

    Visit IBM developerWorks to download IBM DB2 Express-C 9.5, a no-charge version of DB2 Express 9 database server. DB2 Express-C offers the same core data server base features as other DB2 Express editions and provides a solid base to build and deploy applications developed using C/C++, Java, .NET, PHP, and other programming languages.
    FREE! Go There Now!


    NEW! Evaluate IBM Rational Software Analyzer V7.0

    Download a free trial version of IBM Rational Software Analyzer Developer Edition V7.0 to identify bug defects earlier in the software development cycle. Rational Software Analyzer is an extensible software development solution that reduces the expense of bug-fixes by enabling static analysis code reviews and bug identification very early in the development cycle.
    FREE! Go There Now!


    NEW! Hello World: WebSphere Service Registry and Repository

    Manage, govern, and share services across your organization by using WebSphere Service Registry and Repository. Follow the hands-on exercises to learn how to navigate the Web interface to publish, find, reuse, and update services.
    FREE! Go There Now!


    NEW! Rational Talks to You: Grady Booch on Architecture

    Join this Rational Talks to You teleconference on November 29 at 1:00 pm ET to participate in an interactive discusssion with Grady Booch around architecture and reuse. Get your questions answered!
    FREE! Go There Now!


    NEW! The role of integrated requirements management in software delivery

    This paper is about the critical role that a discipline called integrated require­ments management can play in helping to ensure that your business goals and IT investments are continuously aligned—whether you are sourcing, integrat­ing, building or maintaining software. It also looks at ways that automated IBM Rational® products can work together to help you use requirements in the very best way.
    FREE! Go There Now!


    NEW! Try the IBM SOA Sandbox for Process

    Visit IBM developerWorks to try the IBM SOA Sandbox for process. The SOA Sandbox for process focuses on providing a trial environment with the necessary tooling and components required to gain a better understanding of business processes and how to best improve existing business processes to derive value quickly.
    FREE! Go There Now!


    NEW! Webcast: Calling All Testers! Find Application Vulnerabilities Early in the Development Process Where they are Easier to Fix and Less Risky to your Business

    In this webcast, IBM Rational will discuss the importance of Web application security and will share techniques and best practices to introduce application security testing into current QA processes including: understanding common security vulnerabilities and techniques to integrate security testing with defect tracking and remediation systems in an effort to safeguard sensitive online information.
    FREE! Go There Now!


    NEW! Whitepaper: Delivering SOA solutions: service lifecycle management

    The unprecedented scope of a service-oriented architecture (SOA) initiative brings to the forefront a number of management and governance issues that were sidestepped in the past. The key to a successful SOA implementation is managing and governing activities throughout the entire SOA delivery lifecycle by ensuring that services conform to the needs of all of the business’s stakeholders. Learn how service lifecycle management allows the business to ensure that the process by which services are defined, created, tested, deployed, optimized and retired is manageable, repeatable and auditable.
    FREE! Go There Now!



    All FREE IBM® developerWorks Tools!

    ASP.NET CODE ARTICLES

    - How to Use the ListBox Control in ASP.NET 2.0
    - How to Load XML Documents in ASP.NET 2.0
    - DataGrid Code
    - ASP.NET Guestbook
    - User Controls and Client Side Scripting
    - ASP.NET Programming with Microsoft's AS...
    - ASP.NET Basics (part 3): Hard Choices
    - ASP.NET Basics (part 2): Not My Type
    - ASP.NET Basics (part 1): Nothing But .Net
    - Directory Tree Browser
    - How to get the confirmation of Yes/No from a...
    - Complete example using custom errors and wri...
    - Paging Certain # records per page .NET style
    - General Methods of formatting and Subtractin...
    - .NET LinkButton web control





    © 2003-2009 by Developer Shed. All rights reserved. DS Cluster 3 Hosted by Hostway
    For more Enterprise Application Development news, visit eWeek