Java Web Services [4/5]: Java API for XML Web Services
7 likes7,206 views
This document provides an overview of Java APIs for XML web services, including JAX-RPC and JAX-WS. It discusses the Java Web Services Development Pack (JWSDP) and its components like JAXP, JAXB, SAAJ. It then describes specific APIs like JAX-RPC, JAX-WS, JAXR. It also discusses the server-side and client-side programming models in JAX-WS including using annotations and generating code from WSDL.
Java Web Services [4/5]: Java API for XML Web Services
- 1. Topic 4 Java API for XML Web Services Assoc.Prof. Dr. Thanachart Numnonda www.imcinstitute.com August 2010
- 2. Agenda ïŪ Java APIs for Web Services ïŪ JAX-RPC ïŪ JAX-WS 2
- 3. Java APIs for Web Services 3
- 4. JWSDP ïŪ Java Web Services Development Pack (JWSDP) is a free software development kit (SDK) for developing Web Services ïŪ JWSDP has been replaced by GlassFish and WSIT and several components are in Java SE 6. ïŪ JWSDP APIs ïŪ Java API for XML Processing (JAXP), v 1.3 ïŪ Java Architecture for XML Binding (JAXB), v 1.0 and 2.0 ïŪ JAX-RPC v 1.1 ïŪ JAX-WS v 2.0 ïŪ SAAJ (SOAP with Attachments API for Java) ïŪ Java API for XML Registries (JAXR) 4
- 5. Java API for XML Processing (JAXP) âĒ JAXP enables applications to parse, validate and transform XML documents. âĒ Java developers can invoke âĒ SAX parser âĒ DOM parser âĒ The main JAXP APIs are defined in the javax.xml.parsers package âĒ SAXParserFactory âĒ DocumentBuilderFactory 5
- 6. Java API for XML Binding (JAXB) âĒ JAXB allows Java developers to access and process XML data without having to know XML or XML processing. âĒ JAXB is a Java technology that enables you to generate Java classes from XML schemas by means of a JAXB binding compiler. âĒ unmarshalling âĒ XML instance documents into Java content trees âĒ marshalling âĒ Java content trees back into XML instance documents. 6
- 7. SAAJ (SOAP with Attachments API for JavaâĒ) âĒ SAAJ provides a convenient API for constructing and sending SOAP messages without having to directly create the XML yourself. âĒ SAAJ was originally part of the Java API for XML Messaging (JAXM) Separated out from JAXM 1.0 into JAXM 1.1 and SAAJ 1.1 (SAAJ 1.3 (Java EE 5)) 7
- 8. JAXR âĒ Standard Java API for performing registry operations over diverse set of registries Web service publication & discovery âĒ A unified information model for describing business registry content âĒ Provides multi-layered API abstractions Level 0: for UDDI Level 1: for ebXML registry/repository 8
- 9. JAX-RPC âĒ XML data types to/from Java types mapping âĒ SOAP Message Handler framework âĒ WSDL to/from Java mapping âĒ Servlet-based Web service endpoint model âĒ JAX-RPC Client Programming Models âĒ Extensible type mapping 9
- 10. JAX-WS (JAX-RPC 2.0) âĒ New handler framework âĒ Metadata-based Web services âĒ Operational style improvement âĒ Asynchronous Web services âĒ Support for non-HTTP transport âĒ Interoperable attachments (as part of WS-I) âĒ Secure Web services (as part of Security) 10
- 11. JAXM âĒ JAXM is not part of Java EE 5 âĒ JAXM-based asynchronous messaging on Java EE 5 is supported via Message-driven Bean (MDB) in EJB 3 can receive both JMS and JAXM message types Connector 1.5 allows pluggability of various types message providers (JAXM provider and JMS provider) 11
- 12. Java APIs for Web Services Protocols ïŪ SOAP ïŪ JAXM 1.0 (JSR 67), SAAJ ïŪ JAX-RPC => JAX-WS 2.0 (JSR 224) ïŪ WSDL ïŪ JAX-RPC => JAX-WS 2.0 (JSR 224) ïŪ UDDI ïŪ JAXR 1.0 (JSR 93) 12
- 13. Sunâs Web Services Stack 13
- 14. JAX-RPC 14
- 15. Remote Procedure Call (RPC) Request Response Client System Server System ïŪ RPC, COM, CORBA, RMI: ï Synchronous communication: calling process blocks until there is a response ï More tightly coupled (than non-RPC model): client must find recipients and know method and its arguments ï Non persistent
- 16. Remote Procedure Calls Client Interface Interface Servant Stub Skeleton Run Time Protocol Run Time ïŽ Common Interface between client and Server ïŽ Stub for client, Skeleton/Tie for server ïŽ On-the-wire protocol needs to be agreed upon
- 17. RPC Example â Java RMI <<Interface>> Java Remote Interface rmic compiler Client Remote Object Implementation RMI Client RMI Server Stub Skeleton Java Remote Method Protocol (JRMP) is On-the-wire protocol
- 18. RPC Example - JAX-RPC
- 19. Common Interface ïŪ Service is described in IDL (Interface Description Language) ï IDL ofCORBA service ï Java RMI interface in RMI (Language specific) ï WSDL for Web service ïŪ Used by tools to statically or dynamically generate and/or configure interfaces, proxies, and ties in a network technology specific environment
- 20. What is JAX-RPC? ïŪ JavaâĒ API for XML-based RPC ïŪ Web Services operations are performed by exchanging SOAP 1.1 messages ïŪ Services are described using WSDL âĒ WSDL is the contract between service provider and client (only contract needed) ïŪ Web service endpoints and clients use JAX-RPC programming model ïŪ Key technology for Web Services in the J2EE 1.4 platform
- 21. JAX-RPC Design Goals ïŪ Easy to use programming model âĒ For both defining & using a service ïŪ Hides all the plumbing âĒ You don't have to create SOAP messages yourself ïŪ SOAP and WSDL-based interoperability âĒ Interoperate with any SOAP 1.1 compliant peers ïŪ Extensibility and Modularity âĒ Support new versions of XML specification, i.e. SOAP 1.2 and beyond âĒ Message handler architecture
- 22. JAX-RPC Architecture JAX-RPC JAX-RPC Client WSDL Document Service Endpoint Generated JavaïŊWSDL WSDLïģJava Code Container Container Client-side JAX-RPC Server-side JAX-RPC Runtime System Runtime System SOAP HTTP
- 23. JAX-RPC Runtime System ïŪ Core of a JAX-RPC implementation: âĒ Library that provides runtime services for JAX-RPC mechanisms âĒ Implements some of the JAX-RPC APIs ïŪ Client side: âĒ Can be implemented over J2SEâĒ, J2EEâĒ or J2MEâĒ platforms ïŪ Server-side: âĒ J2EE 1.3 or 1.4 Containers: EJBâĒ or Servlet
- 24. Developing a Web Service Interfaces (java.rmi.Remote type) Must follow JAX-RPC conventions Implementation classes Servlet-based endpoint model Optional handler and serializer classes tool WSDL Service contract Packaged application (war file)
- 25. JAX-RPC : Web Service Endpoint JAX-RPC Service Endpoint WSDL<-->Java WSDL Document Container Server-Side JAX-RPC Runtime System SOAP HTTP
- 26. JAX-WS 26
- 27. Quick overview of JAX-WS ïŪ Easy way to use Java API for XML Web Services ïŪ Replace JAX-RPC ïŪ Just add @annotation to POJO ïŪ XML Descriptor free programming ïŪ Layer architecture ïŪ SOAP 1.2 (Document/Literal) ïŪ Use JAXB for data binding ïŪ Protocol and transport independence ïŪ Part of Java SE6 and Java EE 5 Platform 27
- 28. JAX-WS Layered Architecture 28
- 29. What Does It Mean? âĒ Upper layer uses annotations extensively âĒ Easy to use âĒ Great toolability âĒ Fewer generated classes âĒ Lower layer is more traditional âĒ API-based âĒ For advanced scenarios âĒ Most application will use the upper layer only âĒ Either way, portability is guaranteed 29
- 30. Two ways to create a Web Service âĒ Starting from a WSDL file > Generate classes using wsimport (=> xjc) > WS interface > WS implementation skeleton class > Implement WS interface > Build and deploy âĒ Starting from a Java class (POJO) > Annotate POJO > Build and deploy > WSDL file generated automatically 30
- 31. Start with a Java Class 31
- 32. Server-Side Programming Model: POJO 1 Write a POJO implementing the service 2 Add @WebService annotation to it 3 Build and Deploy the application WSDL is automatically generated at runtime 1 Point your clients at the WSDL e.g. http://myserver/myapp/MyService?WSDL 32
- 33. Example 1: Servlet-Based Endpoint @WebService public class Calculator { public int add( int a, int b) { return a + b; } } âĒ @WebService annotation âĒ All public methods become web service operations âĒ WSDL/Schema generated automatically âĒ Default values are used 33
- 34. Service Description Default Mapping âĒ Java mapping => WSDL 34
- 35. Example 2: EJB-Based Endpoint @WebService @Stateless public class Calculator { public int add( int a, int b) { return a + b; } } âĒ Itâs a regular EJB 3.0 component, so it can use any EJB features > Transactions, security, interceptors... 35
- 36. Customizing through Annotations @WebService(name=âCreditRatingServiceâ, targetNamespace=âhttp://example.orgâ) public class CreditRating { @WebMethod(operationName=âgetCreditScoreâ) public Score getCredit( @WebParam(name=âcustomerâ) Customer c) { // ... implementation code ... } } 36
- 37. Start with a WSDL file 37
- 38. Generating an interface from WSDL âĒ WSDL => Java generation 38
- 39. Implementing a Web Service from a Generated Interface 39
- 40. Server Side Web Service 40
- 41. JAX-WS uses JAXB for Data Binding 41
- 42. add() Parameter : Example 42
- 43. JAXB XML Schema to Java Mapping 43
- 44. Client Side Programming 44
- 45. Java SE Client Side Programming âĒ Point a tool (NetBeans or wsimport) at the WSDL for the service wsimport http://example.org/Calculator.wsdl âĒ Generate annotated classes and interfaces âĒ Call new on the service class âĒ Get a proxy using a get<ServiceName>Port method âĒ Invoke any remote operations 45
- 46. Example : Java SE-Based Client CalculatorService svc = new CalculatorService(); Calculator proxy = svc.getCalculatorPort(); int answer = proxy.add(35, 7); âĒ No need to use factories âĒ The code is fully portable âĒ XML is completely hidden from programmer 46
- 47. Java EE Client Side Programming âĒ Point a tool (NetBeans or wsimport) at the WSDL for the service wsimport http://example.org/calculator.wsdl âĒ Generate annotated classes and interfaces âĒ Inject a @WebServiceReference of the appropriate type âĒ No JNDI needed âĒ Invoke any remote operations 47
- 48. Example : Java EE-Based Client @Stateless public class MyBean { // Resource injection @WebServiceRef(CalculatorService.class) Calculator proxy; public int mymethod() { return proxy.add(35, 7); } 48
- 49. Client Side 49
- 50. Annotations Used in JAX-WS âĒ JSR 181: Web Services Metadata for the Java Platform âĒ JSR 222: Java Architecture for XML Binding (JAXB) âĒ JSR 224: Java API for XML Web Services (JAX-WS) âĒ JSR 250: Common Annotations for the Java Platform
- 51. @WebService âĒ Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface. âĒ Attributes > endpointInterface > name > portName > serviceName > targetNamespace > wsdlLocation
- 52. @WebMethod âĒ Customizes a method that is exposed as a Web Service operation âĒ The method is not required to throw java.rmi.RemoteException. âĒ Attributes > action > exclude > operationName
- 53. @WebParam âĒ Customizes the mapping of an individual parameter to a Web Service message part and XML element. âĒ Attributes > header > mode > name > partName > targetNamespace
- 54. @WebResult âĒ Customizes the mapping of the return value to a WSDL part and XML element. âĒ Attributes > header > name > partName > targetNamespace
- 55. JAX-WS - Provider âĒ Web Service endpoints may choose to work at the XML message level by implementing the Provider interface. âĒ The endpoint accesses the message or message payload using this low-level, generic API âĒ Implement one of the following > Provider<Source> > Provider<SOAPMessage> > Provider<DataSource>
- 57. JAX-WS - Dispatch âĒ Web service client applications may choose to work at the XML message level by using the Dispatch<T> APIs. âĒ The javax.xml.ws.Dispatch<T> interface provides support for the dynamic invocation of service endpoint operations. âĒ Similar to Provider on server side
- 59. Resources ï§ Some contents are borrowed from the presentation slides of Sang Shin, JavaâĒ Technology Evangelist, Sun Microsystems, Inc. ï§ Web Services and Java, Elsa Estevez, Tomasz Janowski and Gabriel Oteniya, UNU-IIST, Macau 59
- 60. Thank you [email protected] www.facebook.com/imcinstitute www.imcinstitute.com 60