1 Web Services – Part II CS , Spring 2008/9

2 Axis : Apache EXtensible Interaction System

3 What is AXIS(2)? The Apache Axis2 project is a Java-based implementation of both the client and server sides of the Web services equation.Apache Axis2 Axis is essentially a SOAP engine – a framework for constructing SOAP processors  client side  server side It enables you to :  Send, receive and process SOAP messages  Create a Web service out of a plain Java class  Create implementation classes for both the server and client using WSDL  Easily retrieve the WSDL for a service  Create or utilize a REST-based Web service  And more…

4 Remote Method Invocation is not New java.rmi has been in Java since Java’s early versions In Java RMI, objects can invoke methods of objects that reside on a remote computer  (RMI = Remote Method Invocation) So, what has been changed?  Using HTTP for communication  Using agreed protocols, Java can invoke methods that were not written in Java (e.g.,.NET methods) and vice versa  A complex registry procedure has been required in RMI

5 What We Would Like to Create Client applications: applications that can call a remote Web service Services: methods that can be called by remote applications Service descriptions: WSDL files that describe our methods

6 Live Demo We will build a web service (both server and client side) using Eclipse WTP (already integrated in your J2EE Eclipse version) We will use AXIS2 version 1.3 The demo is based on “Eclipse WTP Tutorials - Creating Bottom Up Web Service via Apache Axis2” with some extensionsEclipse WTP Tutorials - Creating Bottom Up Web Service via Apache Axis2 Guidlelines appear in the following slides

Installin AXIS2 Version 1.3 in Eclipse 1. Download AXIS2 version 1.3 binary distribution (use this link)use this link 2. Set it in Eclipse: Window  Preferences  Web Services  Axis2 Preferences

8 Client Applications

9 Calling Web Services By now, we already know how to invoke a remote Web service in Java:  Open a socket to the remote server  Through the socket, send a SOAP request wrapped by a HTTP request  Parse the response (e.g., using SAX/DOM) However, this approach is cumbersome, and most of it can be automated  This is the whole point of using standards…

10 Web Services Explorer We have a power calculation Web service running on the course server at: We will use Eclipse web services explorer in order to explore it before we write a client for that WS. (Under Run  Launching the Web Services Explorer)

Parameters values for the power function (a^n) The result

It’s all SOAP underneath

13 The WSDL2Java Application Axis provides a mechanism for communicating with a Web service using stubs That is, generation of regular Java classes that have an interface similar to that of the Web service and implementation that wraps Web service management

Creating a new Web service client project

Settings The WSDL location on IBM411 Deploy level Axis 2 Project name (Dynamic Web Application)

16 package cs236607ws; import cs236607ws.PowerCalculationStub.Power; import cs236607ws.PowerCalculationStub.PowerResponse; public class PowerClient { int a = 1; int n = 1; public static void main(String[] args) { try { int a = 3; int n = 4; PowerCalculationStub stub = new PowerCalculationStub(); Power p = new Power(); p.setA(a); p.setN(n); PowerResponse res = stub.power(p); System.out.println("The result of " + a + "^" + n + " is: " + res.get_return()); } catch (Exception e) {System.out.println(e.getStackTrace());} } The client class Added by the programmer using the classes generated by the WSDL2Java:

17 Project Hierarchy Created by WSDL2Java Created by programmer (previous slide). Not necessarily in same package AXIS2 configuration Deployment Descriptor

18 Server Applications

19 We will begin with a service example. Given the base and the exponent (integers), our simple service will calculate the result. This is the class: Creating a Web Service package cs236607WS; public class PowerCalculation { public int power(int a, int n) { return (int) Math.pow(a, n); }

Creating a new Dynamic Web project

Projext Settings Runtime (Tomcat server) Project facets configuration – next slide

Project Facets Configurations Mark Axis2 facet

Create Package + Class (and build the project)

Make it a Web service – Create a new Web service project

Settings “Start” service level Bottom up, meaning you start from Java up to WSDL The class we created Runtime - Tomcat Set to Axis2 !!! The project we created Press it after the settings

Run

What is wrong?

Correct URL Let’s look on the Services

EPR = End Point Reference Click to view the created WSDL

30 The Service WSDL Axis automatically provides a WSDL for each deployed service To get the WSDL, use the service URL with the empty argument wsdl s/PowerCalculationWS?wsdl

31 How Does it Work? The Servlet AxisServlet of this application is responsible for invoking services All URLs of the form /services/* are mapped to the AxisServlet  Where is it written?

32 How Does it Work? (Cont.) When a SOAP request arrives, the AxisServlet object parses the request and invokes the corresponding method of the class associated with the service URL (According to the services that were deployed)

33 Deploying The Service One option, in which you include the entire axis2 application is:  Export the completed project to WAR  Put this WAR under Tomcat webapps directory  That’s it! Usually this is not required, and all you need to deploy is the service only, while axis2 is already deployed. For this you will need to put axis2.war file under $CATALINA_BASE/webapp/  Download AXIS2 version 1.3 WAR distribution (use this link)use this link

34 Service Archive File Now you need to bundle the service files together into a service archive file. The ‘manual’ way: 1. Create an empty folder. 2. Create a directory called "META-INF" inside that. 3. Put services.xml into the META-INF directory. (this file will be discussed later) 4. If you have the WSDL file corresponding to the Web service, rename it to service.wsdl and put that into the same directory. (It is not necessary to have a wsdl file in Axis2.) 5. If you want any third-party lib files or you own lib files, crate a directory called "lib" in the same level as META-INF, and drop all your lib files into that. 6. Copy the compiled service implementation classes into the directory. 7. Create a zip file from all those files and rename it to *.jar or *.aar.

35 Service Archive File (Cont.) The ‘automatic’ way - use service archive generator Eclipse Plug-inservice archive generator Eclipse Plug-in Once you have the service archive file (aar) drop it into the services sub directory in the Axis2 repository ($CATALINA_BASE/webapp/axis2/WEB- INF/services )

36 Service Configuration - services.xml The description of services is specified using services.xml. Each service archive file should have a services.xml in order to be a valid service and it should be available in the META-INF directory of the archive file.  In Eclipse it was created for you.

37 Services.xml example:

38 Service Configuration - services.xml (Cont.) Among the attributes & elements of services.xml are:  Name (service element attribute): The service name will be the name of the archive file if the.aar file contains only one service, or else the name of the service will be the name given by the name attribute.  Scope (service element attribute): The time period during which runtime information of the deployed services will be available. The default value (if you don't enter any value) will be "Request“.

39 Service Configuration - services.xml (Cont.) Axis2 configuration page A short tutorial about writing your own services.xml A short tutorial about writing your own services.xml

40 Resources AXIS2 1.3 Download Eclipse WTP Tutorials - Creating Bottom Up Web Service via Apache Axis2 Eclipse WTP Tutorials - Creating Bottom Up Web Service via Apache Axis2 HU Developer.com Axis2 Documentation