Web Services in.net (6)

Size: px

Start display at page:

Download "Web Services in.net (6)"

Sharyl Stevens
6 years ago
Views:

1 Web Services in.net (6) These slides are meant to be for teaching purposes only and only for the students that are registered in CSE4413 and should not be published as a book or in any form of commercial product, unless written permission is obtained. 1

2 Glue code Upon integration of a web service into an (consumer) application, Visual studio also generates glue code that facilitates generation and transmission of SOAP messages. This code is typically in a file called Reference.cs, residing under the directory where the consumer application is developed. 2

3 Reference.cs Reference.cs contains all the information that would be needed to Generate, bind to HTTP, transmit SOAP messages and receive SOAP messages. Ensure correct syntax when calling the desired web methods and when receiving results from the called methods. It utilizes all the related.net classes for generating SOAP messages, binding them to HTTP, etc. ( normally, a developer could write the Reference.cs file manually, but 3

4 ... It is not that easy! [ Reference.cs ] // // <autogenerated> // This code was generated by a tool. // Runtime Version: // // Changes to this file may cause incorrect behavior and will be lost if // the code is regenerated. // </autogenerated> // // // This source code was auto-generated by Microsoft.VSDesigner, Version // namespace WebApplication1UseMathService.MathWebService using System.Diagnostics; using System.Xml.Serialization; using System; using System.Web.Services.Protocols; using System.ComponentModel; using System.Web.Services; /// <remarks/> 4

5 [System.Diagnostics.DebuggerStepThroughAttribute()] [System.ComponentModel.DesignerCategoryAttribute("code")] [System.Web.Services.WebServiceBindingAttribute(Name="MathServiceSoap", Namespace=" public class MathService : System.Web.Services.Protocols.SoapHttpClientProtocol /// <remarks/> public MathService() this.url = " /// <remarks/> [System.Web.Services.Protocols.SoapDocumentMethodAttribute(" RequestNamespace=" ResponseNamespace=" Use=System.Web.Services.Description.SoapBindingUse.Literal, ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped)] public int Add(int a, int b) object[] results = this.invoke("add", new object[] a, b); return ((int)(results[0])); /// <remarks/> public System.IAsyncResult BeginAdd(int a, int b, System.AsyncCallback callback, object asyncstate) return this.begininvoke("add", new object[] a, b, callback, asyncstate);... For method Add() 5

6 /// <remarks/> public int EndAdd(System.IAsyncResult asyncresult) object[] results = this.endinvoke(asyncresult); return ((int)(results[0])); /// <remarks/> [System.Web.Services.Protocols.SoapDocumentMethodAttribute(" ", RequestNamespace=" ResponseNamespace=" Use=System.Web.Services.Description.SoapBindingUse.Literal, ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped)] public int Minus(int a, int b) object[] results = this.invoke("minus", new object[] a, b); return ((int)(results[0])); /// <remarks/> public System.IAsyncResult BeginMinus(int a, int b, System.AsyncCallback callback, object asyncstate) return this.begininvoke("minus", new object[] a, b, callback, asyncstate); /// <remarks/> public int EndMinus(System.IAsyncResult asyncresult) object[] results = this.endinvoke(asyncresult); return ((int)(results[0])); 6

7 /// <remarks/> [System.Web.Services.Protocols.SoapDocumentMethodAttribute(" RequestNamespace=" ResponseNamespace=" Use=System.Web.Services.Description.SoapBindingUse.Literal, ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped)] public int Times(int a, int b) object[] results = this.invoke("times", new object[] a, b); return ((int)(results[0])); /// <remarks/> public System.IAsyncResult BeginTimes(int a, int b, System.AsyncCallback callback, object asyncstate) return this.begininvoke("times", new object[] a, b, callback, asyncstate); /// <remarks/> public int EndTimes(System.IAsyncResult asyncresult) object[] results = this.endinvoke(asyncresult); return ((int)(results[0])); /// <remarks/> 7

8 / [System.Web.Services.Protocols.SoapDocumentMethodAttribute(" de", RequestNamespace=" ResponseNamespace=" Use=System.Web.Services.Description.SoapBindingUse.Literal, ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped)] public int Divide(int a, int b) object[] results = this.invoke("divide", new object[] a, b); return ((int)(results[0])); /// <remarks/> public System.IAsyncResult BeginDivide(int a, int b, System.AsyncCallback callback, object asyncstate) return this.begininvoke("divide", new object[] a, b, callback, asyncstate); /// <remarks/> public int EndDivide(System.IAsyncResult asyncresult) object[] results = this.endinvoke(asyncresult); return ((int)(results[0])); 8

9 WSDL and SOAP for Employee Web Service Once the web service is compiled, a description of this service is also created: the WSDL (Web Service Definition Language). 9

10 Can always access the WSDL by supplying the URL suffixed with?wsdl. 10

11 The complete WSDL for the Employee WS <?xml version="1.0" encoding="utf-8"?> - <definitions xmlns:http=" xmlns:soap=" xmlns:s=" xmlns:s0=" xmlns:soapenc=" xmlns:tm=" xmlns:mime=" targetnamespace=" xmlns=" - <types> - <s:schema elementformdefault="qualified" targetnamespace=" - <s:element name="makeemployee"> - <s:complextype> - <s:sequence> <s:element minoccurs="0" maxoccurs="1" name="name" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="salary" type="s:double" /> </s:sequence> </s:complextype> </s:element> - <s:element name="makeemployeeresponse"> - <s:complextype> - <s:sequence> <s:element minoccurs="0" maxoccurs="1" name="makeemployeeresult" type="s0:employee" /> </s:sequence> </s:complextype> </s:element> Employee type is the return type of method MakeEmployee. Needs to be further defined. Web method MakeEmployee. 11

12 - <s:complextype name="employee"> - <s:sequence> <s:element minoccurs="0" maxoccurs="1" name="name" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="salary" type="s:double" /> </s:sequence> </s:complextype> </s:schema> </types> - <message name="makeemployeesoapin"> <part name="parameters" element="s0:makeemployee" /> Definition of type </message> Employee. - <message name="makeemployeesoapout"> <part name="parameters" element="s0:makeemployeeresponse" /> </message> - <porttype name="employeeservicesoap"> - <operation name="makeemployee"> <documentation>creates and returns an Employee with the specified name and salary</documentation> <input message="s0:makeemployeesoapin" /> <output message="s0:makeemployeesoapout" /> </operation> </porttype> - <binding name="employeeservicesoap" type="s0:employeeservicesoap"> <soap:binding transport=" style="document" /> - <operation name="makeemployee"> <soap:operation soapaction=" style="document" /> - <input> <soap:body use="literal" /> </input> - <output> <soap:body use="literal" /> </output> </operation> </binding> 12...

13 / - <service name="employeeservice"> - <port name="employeeservicesoap" binding="s0:employeeservicesoap"> <soap:address location=" /> </port> </service> </definitions> 13

14 SOAP for Employee WS :: Consumer to WebService POST /WebService1WithUserDefinedClass/EmployeeService.asmx HTTP/1.1 Host: localhost Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <MakeEmployee xmlns=" <name> string</name> <salary> double</salary> </MakeEmployee> </soap:body> </soap:envelope> 14

15 SOAP for Employee WS :: WebService to Consumer HTTP/ OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <MakeEmployeeResponse xmlns=" <MakeEmployeeResult> <Name> string </Name> <Salary> double </Salary> </MakeEmployeeResult> </MakeEmployeeResponse> </soap:body> </soap:envelope> 15

16 A web service that uses multiple classes Our previous web service (Employee) uses only one class Employee. It is realistic that a web service may involve more than one class. Employee Date Manager Web Service 16

17 Web service with many classes Code structure 17

18 Code structure :: Date 18

19 Code :: Date.cs using System; namespace WebService3ClassSubclass /// <summary> /// Summary description for Class1. /// </summary> public class Date private int year; private int month; private int day; public Date() : this( 1970, 1, 1 ) public Date( int year, int month, int day) this.year = year; this.month = month; this.day = day; 19

20 / public Date (Date adate) this.year = adate.year; this.month = adate.month; this.day = adate.day; public override string ToString() return "year = " + this.year + ", month = " + this.month + ", day = " + this.day ; public int Year get return year; set year = value; public int Month get return month; set month = value; public int Day get return day; set day = value; // end Date class 20

21 Code structure :: Employee 21

22 Code :: Employee.cs using System; namespace WebService3ClassSubclass /// <summary> /// /// </summary> public class Employee private string name ; private double salary; private Date dob; // date of birth // not handled by SOAP? public Employee() : this ("no name", 0, new Date (1970, 1, 1)) public Employee ( string name, double salary, Date dob) this.name = name; this.salary = salary; this.dob = new Date( dob); 22

23 public string Name get return name; set name = value; Code :: Employee.cs public double Salary get return salary; set salary = value; public Date DOB get set return dob; dob = value; public virtual void raise ( double percent ) salary = salary * (1 + percent/100); public override string ToString() return "name = " + this.name + ", salary = " + this.salary + ", DOB = " + this.dob.tostring(); // end class Employee 23

24 Code structure :: Manager 24

25 Code :: Manager.cs using System; namespace WebService3ClassSubclass /// <summary> /// /// </summary> public class Manager : Employee private double bonus; public Manager() : base() public Manager ( string name, double salary, Date dob, double bonus) : base ( name, salary, dob) this.bonus = bonus; public double Bonus get return this.bonus; set this.bonus = value; 25

26 Code :: Manager.cs public override void raise( double percent) base.raise(percent + bonus*.1); public override string ToString() return base.tostring() + ", bonus = " + this.bonus; //end Manager class 26

27 Code Structure :: Service1 Exposed web methods. 27

28 Code :: Service1.cs using System; using System.Collections; using System.ComponentModel; using System.Data; using System.Diagnostics; using System.Web; using System.Web.Services; namespace WebService3ClassSubclass /// <summary> /// Summary description for Service1. /// </summary> public class Service1 : System.Web.Services.WebService public Service1() //CODEGEN: This call is required by the ASP.NET Web Services Designer InitializeComponent(); 28

29 [ WebMethod (Description = "make Employee with specified name and salary") ] public Employee MakeEmployee ( string name, double salary, Date dob ) return new Employee ( name, salary, dob); [ WebMethod (Description="make Manager with specified name, salary, bonus") ] public Manager MakeManager ( string name, double salary, Date dob, double bonus ) return new Manager( name, salary, dob, bonus ); [ WebMethod (Description="return a string representation of the specified Employee") ] public string ToStringEmployee( Employee e) return e.tostring(); [ WebMethod (Description="return a string representation of the specified Manager") ] public string ToStringManager( Manager m) return m.tostring(); 29

30 [ WebMethod (Description = "Return a string rep of the specified Date") ] public string ToStringDate ( Date dd ) return dd.tostring(); [ WebMethod (Description = "Returns a Date with the specified year, month, day") ] public Date MakeDate ( int year, int month, int day ) return new Date(year, month, day); [ WebMethod ( Description = "Raise salary of the specified Employee by the specified percentage.") ] public Employee RaiseEmployeeSalary( Employee ee, double percent) //ee.salary = ee.salary * ( 1 + percent/100); ee.raise( percent ); return ee; [ WebMethod ( Description = "Raise salary of the specified Manager by the specified percentage.") ] public Manager RaiseManagerSalary( Manager mm, double percent) mm.raise( percent ); return mm; 30

31 / #region Component Designer generated code //Required by the Web Services Designer private IContainer components = null; /// <summary> /// Required method for Designer support - do not modify /// the contents of this method with the code editor. /// </summary> private void InitializeComponent() /// <summary> /// Clean up any resources being used. /// </summary> protected override void Dispose( bool disposing ) if(disposing && components!= null) components.dispose(); base.dispose(disposing); #endregion 31

32 A windows app that uses the web service EmployeeManagerDate Pressing the buttons performs the indicated action (by calling a web method of the web service) and displays the outcome on the labels. 32

33 33

Web Services in.net (6) cont d

Web Services in.net (6) cont d These slides are meant to be for teaching purposes only and only for the students that are registered in CSE3403 and should not be published as a book or in any form of commercial