Consuming Web Services in Java 5

eduzine@edujinionline.com (Eduzine) — Tue, 10 Oct 2006 00:01:00 -0700

This article describes how to consume web services in Java 1.5.0 using the new JAX-WS 2.0 API (JSR 228 at http://jcp.org/en/jsr/detail?id=224).

Developers around the world, including me, have always complained about the hard ways to work in Java to consume even a web service as simple as adding two numbers.

However, with JAX-WS 2.0 API now available in core Java in JDK 1.5.0, life is simple like never before.

The article describes how this API can be used for maximum benefits using some off-the-shelf tools similar to wsdl.exe available from Microsoft in the .Net Framework to generate the proxy classes.

Before starting with the discussion, some vocabulary background may be needed for the first timers. Following are simple definitions to the terms used:

Web Service: An operation / task available on a remote application running in an unknown environment.
SOAP: A language in which the two unknown applications would talk to each other.
Message: The content transferred over wire using SOAP as the language.
WSDL: A language that would define the exact grammar of SOAP.
Proxy Class: A piece of code, available on the client machine, that would perform the task of making connections to the server and taking care of serialization and de-serialization.

Publishing a Web Service using ASP.Net:

For our case, we would publish a web service using ASP.Net. You can look into other articles around the globe onto how to publish a web service using ASP.Net.

Here is the synopsis of the web service:

Name: BasicWebServices
Namespace: http://www.edujinionline.com/ns/ws/samples/dn/S01BasicServices/

Operation: Add
Input Message: AddMessage
Output Message: AddMessageResponse
AddMessage: Two parameters, x and y, of type double
AddMessageResponse: One parameter, AddMessageResult, of type double

Consuming the Web Service using JAX-WS 2.0 in Java 1.5

Download JAX-WS Reference Implementation from https://jax-ws.dev.java.net/jax-ws-20-fcs/. Extract the files using the procedure described in the installation section of the document above.

Dig into the bin folder that would have a utility called wsimport. Yes! All those who have worked with wsdl.exe in .Net Framework would immediately understand what the purpose of the tool is

Apart from various other options, the important options supported by the tool are:

-p pkg: Name of the package where the source files will be generated
-s src-directory: Path to the directory where the source files will be kept
-d directory: Path to the directory where the binary files will be kept

On the console, issue the following command (all in one line):

wsimport
    p com.edujinionline.tutorials.services
    s src
    d bin
    http://localhost/BasicWebServices.asmx?WSDL

The last parameter is the location of the WSDL file. Yes, it works with HTTP transport beautifully.

Now now, what? The proxy class is available. You will find the following classes generated:

BasicWebServices
BasicWebServicesSoap
AddMessage
AddMessageResponse
ObjectFactory

... and these are the proxy classes ready for use. See the code below for demonstration.

public class BasicWebServicesClient
{
    public static double testAdd(double x, double y)
    {
        double retVal = 0;

        BasicWebServices service = new BasicWebServices();
        BasicWebServicesSoap soap = service.getBasicWebServicesSoap();

        ObjectFactory factory = new ObjectFactory();
        AddMessage request = factory.createAddMessage();
        request.setX(x);
        request.setY(y);

        AddMessageResponse response = soap.add(request);

        retVal = response.getAddMessageResult();

        return retVal;
    }
}

And the main method to use the wrapper method testAdd described above:

public class MainClass
{
    public static void main(String[] args)
    {
        double x = 34.56;
        double y = 45.67;

        double z = BasicWebServicesClient.testAdd(x, y);
        System.out.printf("%f + %f = %f", x, y, z);
    }
}

Summary

Consuming web services in Java requires just two steps now. The first step is to create proxy classes. Second step is to go ahead and use them.

Documentation, .Net Source et al

You can download all code, documentation with systematic description on how to create the project from http://www.edujinionline.com/downloads.

The article is also available at CodeProject.

Eduzine© - Java

Consuming Web Services in Java 5

Publishing a Web Service using ASP.Net:

Consuming the Web Service using JAX-WS 2.0 in Java 1.5

Summary

Documentation, .Net Source et al