SOAP Web Services Objektumorientált szoftvertervezés Object-oriented software design. Web services 11/23/2016. Outline. Remote call.

Size: px

Start display at page:

Download "SOAP Web Services Objektumorientált szoftvertervezés Object-oriented software design. Web services 11/23/2016. Outline. Remote call."

Stanley Carroll
6 years ago
Views:

1 SOAP Web Services Objektumorientált szoftvertervezés Object-oriented software design Outline Web Services SOAP WSDL Web Service APIs.NET: WCF Java: JAX-WS Dr. Balázs Simon BME, IIT 2 Remote call Remote communication technologies: Remote Method Invocation (RMI): binary, only within the same framework (Java /.NET) SOAP web services: XML, even between different frameworks and languages Java: Java API for XML-based web services (JAX-WS).NET: Windows Communication Foundation (WCF) REST services: XML, JSON, etc., even between different frameworks and languages Java: Java API for RESTful Web Services (JAX-RS).NET: Windows Communication Foundation (WCF) Client memory space Web service API Client object Web service framework Server interface Proxy Web service framework Server memory space Adapter Server interface Web service API Server implementation Serialization/ Deserialization Network Serialization/ Deserialization DB Web service standards 3 4 A technology for creating services Standardized (OASIS, W3C) Independent of programming languages, frameworks and operating systems XML-based Transport protocol: usually HTTP Widespread, widely supported Various standards for middleware tasks: addressing, reliable messaging, security, transactions find client UDDI service repository WSDL request SOAP publish service 5 WSDL = Web-Services Description Language SOAP = Simple Object Access Protocol UDDI = Universal Description, Discovery and Integration 6 1

2 Definition: service available through SOAP messages Message format: SOAP = Simple Object Access Protocol Versions: 1.1 and 1.2 Interface descriptor: WSDL = Web-Services Description Language Versions: 1.1 and 2.0 Service repository: UDDI = Universal Description Discovery and Integration Versions: 2.0 and 3.0 Example: SOAP request <s:envelope xmlns:s=" <s:body> <SayHello xmlns=" <name>me</name> </SayHello> </s:body> </s:envelope> 7 8 Example: SOAP response Example: WSDL 1/7 <s:envelope xmlns:s=" <s:body> <SayHelloResponse xmlns=" <SayHelloResult>Hi: me</sayhelloresult> </SayHelloResponse> </s:body> </s:envelope> <wsdl:definitions targetnamespace=" xmlns:xs=" xmlns:wsdl=" xmlns:soap=" xmlns:wsaw=" xmlns:tns=" xmlns:ns0=" </wsdl:definitions> 9 10 Example: WSDL 2/7 Example: WSDL 3/7 <wsdl:types> <xs:schema targetnamespace=" xmlns:tns=" xmlns:ns0=" elementformdefault="qualified"> <xs:element name="sayhello" nillable="true" type="ns0:sayhello"/> <xs:complextype name="sayhello"> <xs:sequence> <xs:element name="name" type="xs:string" nillable="true"/> </xs:sequence> </xs:complextype> 11 <xs:element name="sayhelloresponse" nillable="true" type="ns0:sayhelloresponse"/> <xs:complextype name="sayhelloresponse"> <xs:sequence> <xs:element name="sayhelloresult" type="xs:string" nillable="true"/> </xs:sequence> </xs:complextype> </xs:schema> </wsdl:types> 12 2

3 Example: WSDL 4/7 Example: WSDL 5/7 <wsdl:message name="ihelloworld_sayhello_inputmessage"> <wsdl:part name="parameters" element="ns0:sayhello"/> </wsdl:message> <wsdl:message name="ihelloworld_sayhello_outputmessage"> <wsdl:part name="parameters element="ns0:sayhelloresponse"/> </wsdl:message> 13 <wsdl:porttype name="ihelloworld"> <wsdl:operation name="sayhello"> <wsdl:input wsaw:action= " message="ns0:ihelloworld_sayhello_inputmessage"/> <wsdl:output wsaw:action= " message="ns0:ihelloworld_sayhello_outputmessage"/> </wsdl:operation> </wsdl:porttype> 14 Example: WSDL 6/7 Example: WSDL 7/7 <wsdl:binding name="ihelloworld_basichttpbinding_binding" type="ns0:ihelloworld"> <soap:binding style="document" transport=" <wsdl:operation name="sayhello"> <soap:operation style="document" soapaction= " <wsdl:input> <soap:body use="literal"/> </wsdl:input> <wsdl:output> <soap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> 15 <wsdl:service name="helloworld"> <wsdl:port name="ihelloworld_basichttpbinding_port" binding="ns0:ihelloworld_basichttpbinding_binding"> <soap:address location= " </wsdl:port> </wsdl:service> 16 UDDI service repository find client WSDL request SOAP publish service SOAP WSDL = Web-Services Description Language SOAP = Simple Object Access Protocol UDDI = Universal Description, Discovery and Integration

SOAP history Originally: 1998. Microsoft SOAP = Simple Object Access Protocol XML-based RPC Today: W3C Versions: 1.1 and 1.

4 SOAP history Originally: Microsoft SOAP = Simple Object Access Protocol XML-based RPC Today: W3C Versions: 1.1 and 1.2 the abbreviation remained SOAP, however, it is not extracted any more SOAP Communication protocol Between applications Based on XML Platform independent Programming language independent Simple Extensible see later: WS-* standards Independent of the transport layer, however, the most common transport is HTTP SOAP envelope SOAP 1.1 <env:envelope xmlns:env="[soap névtér]"> <env:header> <myns:myheader1 xmlns:myns="[mynamespace]"/> <myns:myheader2 xmlns:myns="[mynamespace]" env:mustunderstand="1"/> Envelope </env:header> <env:body> <env:fault> </env:fault> </env:body> </env:envelope> Header? Body Custom header* Custom content? or Fault? SOAP message namespace: WSDL namespace: HTTP headers: POST [local URL] HTTP/1.1 Content-Type: text/xml; charset="utf-8 SOAPAction: [Action] SOAPAction is mandatory SOAP 1.2 SOAP message namespace: WSDL namespace: The Fault element has a different structure than in version 1.1 HTTP headers: POST [local URL] HTTP/1.1 Content-Type: application/soap+xml; charset=utf-8; action= [Action] action is optional GET method is also allowed 23 WSDL 24 4

5 abstract concrete 11/23/2016 WSDL Web Services Description Language Descriptor for web services interface meta-data service address W3C Versions: 1.1 and WSDL 1.1 definitions import* types? message* porttype* schema* part* operation* input? output? binding* fault* operation* input? output? fault* service* port* definitions: root element import: other WSDL types: used types XML schema (XSD) message: parameter list part: parameter porttype: interface operation: function input: input parameters output: output parameters fault: exception binding: calling convention protocol, data format, encoding service: implementation port: location of the service with the given binding 26 WSDL 1.1: types in XSD WSDL 1.1: abstract part <xsd:schema targetnamespace="[mynamespace]" xmlns:myns="[mynamespace]" elementformdefault="qualified"> <xsd:import schemalocation="" namespace="[mynamespace]"/>* <xsd:element name="[ncname]" type="[qname]"/>* <xsd:complextype name="[ncname]"/>* </xsd:schema> Legend: [ncname] = name definition (e.g. Add ) [qname] = name reference with namespace prefix (e.g. myns:add ) 27 <wsdl:definitions name="pilottest" targetnamespace="[mynamespace]" xmlns:myns="[mynamespace]" xmlns:wsdl=" xmlns:xsd=" <wsdl:import location="" namespace="[mynamespace]"/>* <wsdl:types>? <xsd:schema targetnamespace="[mynamespace]" elementformdefault="qualified">* <xsd:import schemalocation="" namespace="[mynamespace]"/>* </xsd:schema> definitions </wsdl:types> import* <wsdl:message name="[ncname]">* <wsdl:part name="[ncname]" element="[qname]"/>* </wsdl:message> <wsdl:porttype name="[ncname]">* <wsdl:operation name="[ncname]">* <wsdl:input message="[qname]"/>? <wsdl:output message="[qname]"/>? <wsdl:fault name="[ncname]" message="[qname]"/>* Dr. </wsdl:operation> Balázs Simon, BME, IIT </wsdl:porttype> </wsdl:definitions> types? message* porttype* schema* part* operation* input? output? fault* 28 WSDL 1.1: concrete part <wsdl:definitions name="pilottest" targetnamespace="[mynamespace]" xmlns:myns="[mynamespace]" xmlns:wsdl=" xmlns:soap=" xmlns:soap12=" <wsdl:import location="" namespace="[mynamespace]"/>* <wsdl:binding name="[ncname]" type="[qname]">* <wsdl:operation name="[ncname]">* <wsdl:input></wsdl:input>? <wsdl:output></wsdl:output>? <wsdl:fault name="[ncname]"></wsdl:fault>* </wsdl:operation> </wsdl:binding> definitions import* binding* <wsdl:service name="[ncname]">* <wsdl:port name="[ncname]" binding="[qname]"></wsdl:port>* </wsdl:service> operation* input? output? fault* service* port* WSDL 1.1 MEP MEP = Message Exchange Pattern Depends on the input/output parameters there is input there is output request-reply no output one-way (asynchronous) no input solicit-response - </wsdl:definitions>

6 WSDL 1.1 summary WSDL 2.0 Not yet widespread and not yet widely supported Simpler than version 1.1 Root: description instead of definitions There is import and include Reduced redundancy: no message Reusable bindings interface instead of porttype (Multiple) inheritance among interfaces WSDL 2.0 summary Web service APIs JAX-WS Java API for XML-based Web Services Goal: Mapping between SOAP web services and Java Uses Java annotations Does not cover WS-* protocols Implementations: Apache CXF (recommended) Apache Axis2 Oracle WebLogic, Sun Metro JBoss: uses Apache CXF IBM: built on Apache Axis2 WCF Windows Communication Foundation (since.net 3.0) Goal: Simple implementation of web services Mapping between web services and.net classes Uses.NET Attributes Similar to JAX-WS Supports WS-* standards

7 JAX-WS JAX-WS used on an interface or class defines the contract or implementation used on a method defines a published used on a method parameter defines the parameter name used on a method indicates that the operation is used on an exception class defines a web service public interface ICalculator double add(double left, double right); double multiply(double left, double right); 39 @WebService(endpointInterface="soixmlwsapi.ICalculator") public class Calculator implements ICalculator public double add(double left, double right) return left+right; public double multiply(double left, double right) return = " public interface ICalculator (operationname="add") double add(@webparam(name="left") double double = " endpointinterface="soaxmlwsapi.icalculator", wsdllocation="web-inf/wsdl/calculator.wsdl") public class Calculator implements ICalculator //

8 @OneWay // Service public interface void AddAsync(double left, double right); // Client callback public interface void = "MathFault", proporder = "errorcode", "errormessage" ) public class = "ErrorCode", required = true, nillable = false) protected int = "ErrorMessage", required = true, nillable = true) protected String errormessage; // getters & setters 43 = "MathFault", targetnamespace = " public class MathException extends Exception private MathFault faultinfo; public MathException(String message, MathFault faultinfo) super(message); this.faultinfo = faultinfo; public MathFault getfaultinfo() return public interface ICalculator double divide(double left, double right) throws MathException; Publish as a console application JDK: Endpoint.publish(" new Calculator()); JDK Tools wsimport generates client code from a WSDL generated classes from interface from <porttype> and <binding> a client proxy factory class for retrieving a proxy object implementing interface Can be used on the server side for top-down development

9 Client Dynamic address try // Create client proxy factory: CalculatorService service = new CalculatorService(); // Get the client proxy object: ICalculator calculator = service.geticalculatorbasichttpbindingport(); // Use the service: double addresult = calculator.add(3.1, 4.7); double divideresult = calculator.divide(3.1, 4.7); catch (MathException e) e.printstacktrace(); 49 try // The new service address: String addr = " // Create client proxy factory: CalculatorService service = new CalculatorService(); // Get the client proxy object: ICalculator calculator = service.geticalculatorbasichttpbindingport(); // Set the new address: BindingProvider bp = (BindingProvider)calculator; bp.getrequestcontext().put(bindingprovider.endpoint_address_property, addr); // Use the service: double addresult = calculator.add(3.1, 4.7); double divideresult = calculator.divide(3.1, 4.7); catch (MathFault e) e.printstacktrace(); 50 9

Web Service APIs. Szolgáltatásorientált rendszerintegráció Service-Oriented System Integration. Dr. Balázs Simon BME, IIT

Web Service APIs. Szolgáltatásorientált rendszerintegráció Service-Oriented System Integration. Dr. Balázs Simon BME, IIT Web Service APIs Szolgáltatásorientált rendszerintegráció Service-Oriented System Integration Dr. Balázs Simon BME, IIT Outline XML binding APIs Java: JAXB.NET: WCF DataContract Web service APIs Java: