Developing a simple Calculator We= b service

Page edited by Ying Tang

=20

Developing Clients for a JAX-WS = Web Service

This tutorial will walk you through building and developing the JAX-WS c= alculator that ships with the samples package for Geronimo. After completin= g this tutorial, you should be able to understand how to build simple Web s= ervices with Apache Geronimo
using the Eclipse development environment.

To run this tutorial, as a minimum you will be required to have installe= d the following prerequisite software.

Sun JDK 6.0+ (J2SE 1.6)
Eclipse IDE for Java EE Developers, which is platform specific
Apache Geronimo Eclipse Plugin 2.2.x

Apache Geronimo Server 2.2.x

Geronimo version 2.2, Java 1.6 runtim= e, and Eclipse Ganymede are used is used in this tutorial but other version= s can be used instead (for example, Geronimo version 2.1, Java 1.5, Eclipse= Europa)

Details on installing eclipse are provided in the Development environment section. This tutorial is organized in the f= ollowing sections:

Setting Eclipse for application development

Create a Dynamic Web project

Select File -> New, select Other....
In the popup window select Web -> Dynamic Web Project cate= gory and click Next.
Type in jaxws-calculator as the Project name and s= elect Next.
Make sure Generate Deployment Descriptor is selected and clic= k Next.

Modify the Group Id to: org.apache.geronimo.samples.jws= and Artifact Id to: Calculator.

Useful Information

Group ID: A name that identifies the group of a module. The default = value is default.
Artifact ID: A name of the module in a group. The default value is &= lt;blank>.
Version: The version of module. The default value is 1.0
Type: The type of module, such as system module (car), jar module (j= ar), web archive (war), enterprise archive (ear), and so on. The default va= lue is car. A module is stored inside a repository as repository/groupId/ar= tifactId/version/artifactIdversion.
type. This repository structure gives a more standardized and easily mainta= inable
structure to Geronimo applications.

Axis2 configuration

Select Window -> Preferences.
Select Web Services -> Axis2 Preferences.

Under Axis2 Runtime tab, browse to the installation root of= the Axis2 runtime installation to be used in Eclipse. Select OK.

Useful Information

A = separate Axis2 runtime is required for use by the Eclipse Axis2 project fac= et. You can use the pre-integrated Axis2 1.4 binaries (axis-1.4.jar) from t= he local Geronimo repository under <Geronimo_home>/repository/axis/ax= is/1.4

Righ click on the jaxws-calculator project and select Prop= erties, then select Project Facets.
On the next screen check the box for Axis2 Web Services.
Select Finish.
This completes the configuration of Eclipse for application development.

Creating the Web services implementation code

To implement the Calculator Web service we are going to create a = package called org.apache.geronimo.samples.jws. This package will = contain two classes: a Calculator interface, and a CalculatorS= ervice which implements the Calculator interface. Let's go step= by step with creating the package, interface class and implementation clas= s.

Right click on Java Resources: src and select New -> Pa= ckage.
Name the package as org.apache.geronimo.samples.jws. Select= Finish.
Right click on the new package and Select New -> Interface= .

<= br clear=3D"all" />
Name the interface as Calculator. Select Finish.

=

Add the following code to the Calculator interface class:

Calculator.class

package org.apache.geronimo.samples.jws=
;

import javax.jws.WebService;
import javax.jws.WebMethod;
import javax.jws.WebParam;

@WebService(name=3D"CalculatorPortType",
            targetNamespace =3D "http://jws.samples.geronimo.apache.org")
public interface Calculator {

    @WebMethod
    public =
int add(@WebParam(name =3D "value1") int value1,
                   @WebParam(name =3D "value2") int value2);

}

Right click on the package org.apache.geronimo.samples.jws an= d select New -> Class.
Name the class CalculatorService.
Accept all the defaults and Select Finish..

Add the following code to CalculatorService class:

CalculatorService.class

package org.apache.geronimo.samples.jws=
;

import javax.annotation.Resource;
import javax.jws.WebService;
import javax.xml.ws.WebServiceContext;

@WebService(serviceName =3D "Calculator",
            portName=3D"CalculatorPort",
            endpointInterface =3D "org.apache.ge=
ronimo.samples.jws.Calculator",
            targetNamespace =3D "http://jws.samples.geronimo.apache.org"
            )
public class CalculatorService implements Calculator {

    @Resource
    private WebServiceContext context;

    public =
int add(int value1, int value2) {
        System.out.println("User Principal: " + context.getUserPrincipal());
        return value1 + value2;
    }
}

Let us try to understand each annotation.

@WebService- This annotation can be used with a Java class as= well as with interface. In our case we used it with both interface as well= as the POJO. This annotation declares the POJO as a WebService. @WebServic= e annotation is utilized in generating the WSDL file. =09
- serviceName is same as the WSDL element service
- name is same as the WSDL element <portType name> =09=09
- endpointInterface suggests the user defined name for the S= ervice Endpoint Interface (SEI).
- portName is the element portName
- targetNamespace is the XML namespace of the WSDL and some = of the XML elements generated from the WebService
=09
@WebMethod- This annotation is applied to a method to expose = it as a WebService method. In case you have multiple methods you can use th= is annotation to selectively expose methods as WebService method. If you do= not use this annotation all the public methods will be exposed as WebServic= e.
@WebParam- This annotation is used along with @WebMethod anno= tation to define the WebService. It is used to customize parameter used in = the message part of the WSDL.

This completes the development of the Web Service Implementation code.

Generating the WSDL for the Web service

Geronimo provides a new jaxws-tools.bat which helps in generating the WS= DL file from service endpoint interface.

Export the source files to a jar as shown in the following three fig= ures.

<= br clear=3D"all" />

<= br clear=3D"all" />
Open a command prompt and point it to the bin directory of se= rver installation. =09
1. Run the command:
  =
  WSDL Generation command
```
Administrator@T60J9:/> jaxws-tools.bat wsgen -classpath C:/WSDL/source.j=
ar -d C:/WSDL/ -wsdl:soap1.1 org.apache.geronimo.samples.jws.CalculatorServ=
ice
```
  In this command -classpath is used to set the source.jar e= xported from Eclipse in the classpath, -d defines the location where= all the generated artifacts will be placed, -wsdl:soap1.1 suggests = a WSDL generation following soap1.1 protocol, and org.apache.geronimo.sa= mples.jws.CalculatorService is the SEI used to generate the WSDL.
  =09=09
2. Once the above command is run Calculator_schema1.xsd and= Calculator.wsdl will be generated at C:/WSDL/.
3. Rename Calculator.wsdl as CalculatorService.wsdl and add both the generated files to WEB-INF directory of the project. =09
=09

Developing a Web client for Calculator This section will take you through the creation of two JSP's: index.= jsp and result.jsp. index.jsp will prompt the user t= o enter two whole number values to add together. After submitting the form,= the action will be forwarded to the result.jsp, which will call t= he Calculator Web Service. =09Right click on the Web Content folder and Select New --> JSP. =09Name the JSP as index.jsp and select Finish. =09Add the following code to index.jsp: = index.jsp <%@ page import=3D"java.net.URL,javax.xml.namesp= ace.QName,javax.xml.ws.Service,org .apache.geronimo.samples.jws.Calculator"%> <html xmlns=3D"http://www.w3.org/1999/xhtml" xml:lang=3D"= en"> <head> <title>Calculator</title> </head> <body> <form action=3D"result.jsp"> Please enter 2 whole numbers to add: <input type=3D"text" name=3D"value1"> + <input type=3D"text" name=3D"v= alue2"> <input type=3D"submit" value=3D"=3D"> </form> </body> </html> =09Right click on the Web Content folder and Select New -> JSP. =09Name the JSP as result.jsp and select Finish. =09Add the following code to result.jsp: = result.jsp <%@ page import=3D"java.net.URL,javax.xml.namesp= ace.QName,javax.xml.ws.Service,org .apache.geronimo.samples.jws.Calculator"%> <html xmlns=3D"http://www.w3.org/1999/xhtml" xml:lang=3D"= en"> <head> <title>Calculator Result</title> </head> <% int value1 =3D 0; int value2 =3D 0; int sum =3D 0; try { System.out.println( request.getParameter= ( "value1" ) + " " + request.getParameter( "value2" ) ); value1 =3D Integer.parseInt( request.get= Parameter( "value1" ) ); value2 =3D Integer.parseInt( request.get= Parameter( "value2" ) ); URL url =3D new URL("http://localhost:8080/jaxws-calculator- 1.0/calculator?wsdl"); QName qname =3D new QName("http://jws.s= amples.geronimo.apache.org", "Calculator"= ); Service service =3D Service.create(url, qname); Calculator calc =3D (Calculator)service.getPort(Calculator.class); sum =3D calc.add(value1, value2); } catch ( Exception e ) { e.printStackTrace(); } %> <body> The result is: <%=3Dvalue1%>+<%=3Dvalue2%>=3D<%=3Dsum%> <br> <a href=3D"index.jsp">Back</a>= ; </body> </html> This finishes the development of Web client. Setting up the Deployment Descriptor and D= eployment Plan =09Double click WEB-INF/web.xml and add the following code: = web.xml <?xml version=3D"1.0" encoding=3D"UTF-8"?> <web-app xmlns:calc=3D"urn:geronimo-samples-j= ws" xmlns=3D"http://jav= a.sun.com/xml/ns/javaee" version=3D"2.5"> <servlet> <display-name>CalculatorService</display-name> <servlet-name>CalculatorService</servlet-name> <servlet-class> org.apache.geronimo.samples.jws.CalculatorService </servlet-class> </servlet> <servlet-mapping> <servlet-name>CalculatorService</servlet-name> <url-pattern>/calculator</url-pattern> </servlet-mapping> <service-ref> <service-ref-name>services/Calculator</service-ref-nam= e> <service-interface>ja= vax.xml.ws.Service</service-interface> <wsdl-file>WEB-INF/CalculatorService.wsdl</wsdl-file&g= t; </service-ref> </web-app> =09Similarly double click geronimo-web.xml and add the following= code: = geronimo-web.xml <?xml version=3D"1.0" encoding=3D"UTF-8"?> <web:web-app xmlns:dep=3D"http://geronimo.apache.org/xml/ns/deployment-1.2"=20 xmlns:conn=3D"http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"= =20 xmlns:name=3D"http://geronimo.apache.org/xml/ns/naming-1.2"=20 xmlns:ejb=3D"http://openejb.apache.org/xml/ns/openejb-jar-2.2"=20 xmlns:pkgen=3D"http://openejb.apache.org/xml/ns/pkgen-2.1"=20 xmlns:app=3D"http://geronimo.apache.org/xml/ns/j2ee/application-2.0"=20 xmlns:sec=3D"http://geronimo.apache.org/xml/ns/security-2.0"=20 xmlns:web=3D"http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1"=20 xmlns:pers=3D"http://java.sun.com/xml/ns/persistence"=20 xmlns:client=3D"http://geronimo.apache.org/xml/ns/j2ee/application-client-= 2.0"> <dep:environment> <dep:moduleId> <dep:groupId>org.apache.geronimo.samples.jws</dep:grou= pId> <dep:artifactId>Calculator</dep:artifactId> <dep:version>1.0</dep:version> <dep:type>car</dep:type> </dep:moduleId> <dep:dependencies> </dep:dependencies> </dep:environment> <context-root>/jaxws-calculator-1.0</context-root> <service-ref> <service-ref-name>services/Calculator</service-ref-name>= ; <port> <port-name>CalculatorPort</port-name> <protocol>http</protocol> <host>localhost</host> <port>8080</port> <uri>/jaxws-calculator/calculator</uri> </port> </service-ref> </web:web-app> Depl= oy and Run =09Right click on jaxws-calculator project. Select Run As -&g= t; Run On Server. =09On the next window select Apache Geronimo V2.2 and Select Finish.= =09Once the application is deployed on the server launch a browser and = run the following URL http://localhost:8080/jaxws-calculator-1.0/ind= ex.jsp. =09Give the values as 5 and 7 and then select the =3D<= /b> button: =09The result is 12 as shown in the figure: =

Change Notification Preferences View Online | View Cha= nge | Add Comment