Login

Your Trail

Table of Contents [show]

Keywords

SOAP, WSDD, WSDL, jws

Copyright Information

This article is licensed under GNU Public License. Some of the images in this article may have different copyright licenses. Please follow the URLs of the images for detailed information about their specific copyright licenses. Contact webmasters for more information on copyright issues.

[A]

1 Introduction

Apache Axis is an implementation of the SOAP ("Simple Object Access Protocol") submission to W3C. Axis is a framework for providing SOAP-based web services. Currently it has a Java version and a C++ version.

2 Getting Started

There are quite a few manual documents in AXIS Website(http://ws.apache.org/axis)], You may find it easier to start from the [User Guide (http://ws.apache.org/axis/java/user-guide.html)] and try out the examples.

3 Deploying Web Services, by Example

Basically, there are two ways to deploy a web service in Axis: First, you could simply rename your regular .java file to .jws and put it in your Axis deployement directory. The magic of .jws-based deployment lies in the web.xml file. Take a look at $TOMCAT/axis/WEB-INF/web.xml you'll find the following servlet config

  <servlet-mapping>
    <servlet-name>AxisServlet</servlet-name>
    <url-pattern>*.jws</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>AxisServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>

Yup, all .jws requests are redirected to AxisServlet, where the web service calls are processed. Same thing with services deployed with WSDD Your Axis deployment directory is usually webapps/axis/. Or, you could use Web Service Deployment Descriptor WSDD, which gives you more control over how the service is deployed, and even further Web Service Description Language (WSDL), which uses WSDD and also simplifies client programming.

3.1 Deploying web service through .jws

Rename your regular .java file to .jws and put it in your Axis deployement directory.

3.2 Deploying web services through WSDD

Check to make sure that axis is installed. To install, unpack axis installation tarball, and copy webapps/axis to $TOMCAT/webapps/
Check to make sure that axis has been deployed. To redeploy, you could use the ultimate solution: restart Tomcat

Create a java file Quote.java, which will be the service provider:

package quote;

import java.util.*;

public class Quote {
  private HashMap<String, String> quotes = null;
  public Quote() {
    quotes = new HashMap<String, String>();
    quotes.put(new String("Groucho Marx"), new String("Time flies like an arrow.  Fruit flies like a banana."));
    quotes.put(new String("Mae West"), new String("When women go wrong, men go right after them."));
    quotes.put(new String("Mark Twain"), new String("Go to Heaven for the climate, Hell for the company."));
  }
  public String quote(String name) {
    String quote;
    if (name = = null || name.length() = = 0
      || (quote = (String) quotes.get(name)) = = null) {
      quote = "No quotes.";
    }
    return (quote);
  }
  public int count() {
    return quotes.size();
  }
  public String[] contents() {
    String[] s = new String[quotes.size()];

    Set keys = quotes.keySet();
    int j = 0;
    for (Iterator i = keys.iterator(); i.hasNext(); ) {
      String name = (String) i.next();
      s[j++] = (String) quotes.get(name);
    }
    return s;
  }

  public long time() {
    return System.currentTimeMillis();
  }
}

use javac to compile this file in any directory: javac Quote.java
mkdir $TOMCAT/axis/WEB-INF/classes/quote
copy Quote.class $TOMCAT/axis/WEB-INF/classes/quote
cd $TOMCAT/axis/WEB-INF/classes

create deploy.wsdd as follows:

<deployment
     xmlns="http://xml.apache.org/axis/wsdd/"
     xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">
       <service name="Quote" provider="java:RPC">
         <parameter name="className" value="quote.Quote"/>
         <parameter name="allowedMethods" value="*"/>
       </service>
</deployment>

This deployment descriptor deploys quote.Quote as a service "Quote"

use axis AdminClient to deploy this service: java -cp .:$AXIS_JAR_FILES org.apache.axis.client.AdminClient -h localhost -p8080 deploy.wsdd
check to make sure your service has been successfuly deployed: java -cp .:$AXIS_JAR_FILES org.apache.axis.client.AdminClient -h localhost -p8080 list

3.3 Using WSDL to deploy and access web service

cd $TEST_DIR

create quote/Quote.java

package quote;

import java.util.*;

public class Quote {
  private HashMap<String, String> quotes = null;
  public Quote() {
    quotes = new HashMap<String, String>();
    quotes.put(new String("Groucho Marx"), new String("Time flies like an arrow.  Fruit flies like a banana."));
    quotes.put(new String("Mae West"), new String("When women go wrong, men go right after them."));
    quotes.put(new String("Mark Twain"), new String("Go to Heaven for the climate, Hell for the company."));
  }
  public String quote(String name) {
    String quote;
    if (name = = null || name.length() = = 0
      || (quote = (String) quotes.get(name)) = = null) {
      quote = "No quotes.";
    }
    return (quote);
  }
  public int count() {
    return quotes.size();
  }
  public String[] contents() {
    String[] s = new String[quotes.size()];

    Set keys = quotes.keySet();
    int j = 0;
    for (Iterator i = keys.iterator(); i.hasNext(); ) {
      String name = (String) i.next();
      s[j++] = (String) quotes.get(name);
    }
    return s;
  }

  public long time() {
    return System.currentTimeMillis();
  }
}

javac Quote.java
mkdir quote
mv Quote.class quote

create a web service description language file quote.wsdl:

java org.apache.axis.wsdl.Java2WSDL  -o quote.wsdl -l"http://localhost:8080/axis/services/Quote"  -n "urn:Quote"  -p"quote" "urn:Quote" quote.Quote

generate web service interface and service classes:
```
java org.apache.axis.wsdl.WSDL2Java  -o . -d Session -s -S true-Nurn:Quote quote.wsdl
```
This will generate a "Quote_pkg" directory with the following files:
- deploy.wsdd : used for service deployement
- Quote.java : common interface used by both web service and clients
- QuoteService.java : the service
- QuoteServiceLocator.java : used by client
- QuoteSoapBindingImpl.java : used by server
- QuoteSoapBindingStub.java : used by client
- undeploy.wsdd : use for service undeploy
cd Quote_pkg
vi QuoteSoapBindingImpl.java, replace with actual implementation
javac *.java
mkdir $TOM_CAT/axis/WEB-INF/classes/Quote_pkg
cp Quote.class QuoteService.class QuoteSoapBindingImpl.class $TOMCAT/axis/WEB-INF/classes/Quote_pkg/
cp deploy.wsdd undeploy.wsdd $TOMCAT/axis/WEB-INF/classes
cd $TOMCAT/axis/WEB-INF/classes/
java org.apache.axis.client.AdminClient -p 8080 deploy.wsdd
cd $TEST_DIR
cp Quote_pkg/QuoteServiceLocator.class Quote_pkg/QuoteSoapBindingStub.class Quote_pkg/Quote.class quote

create Test.java

import java.util.Date;
import Quote_pkg.*;

public class Test {
  public static void main(String[] args) throws Exception {
    QuoteServiceLocator l = new QuoteServiceLocator();
    QuoteSoapBindingStub stub = (QuoteSoapBindingStub) l.getQuote();

    System.out.println("Time on server: " + (new Date(stub.time())).toString());
    System.out.println(stub.quote("Groucho Marx") + " -- Groucho Marx");
    System.out.println("Number of quotes: " + stub.count());

    String[] quotes = stub.contents();
     for (int i = 0; i < quotes.length; i++) {
       System.out.println(quotes[i]);
    }
  }
}

compile and run client
continue if you want to test through a web client
cd $TOMCAT/axis/WEB-INF/classes
jar -cvf quote.jar `find Quote_pkg "*.class"`
mv quote.jar $TOMCAT/webapps/testquote/WEB-INF/lib
cd $TOMCAT/webapps/testquote/, create testquote directory if it is not there yet

create the following .jsp file:

<%@ page language="java" import="java.util.*" %>
<%@ page language="java" import="testquote.*" %>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <base href="<%=basePath%>">

    <title>Login</title>

    <meta http-equiv="pragma" content="no-cache">
    <meta http-equiv="cache-control" content="no-cache">
    <meta http-equiv="expires" content="0">
    <meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
    <meta http-equiv="description" content="This is my page">

    <!--
    <link rel="stylesheet" type="text/css" href="styles.css">
    -->
  </head>

  <body>
  <%
    response.getWriter().println("Status: " + TestQuote.quote());
  %>
  </body>
</html>

cd $TOMCAT/webapps/testquote/WEB-INF/classes/testquote/, create testquote directory if it's not there yet.

create the following java file, and compile it

package edu.msu.egr.decs.logintest;

import Quote_pkg.*;

public class TestQuote {
    public static String quote() throws Exception {
        QuoteServiceLocator l = new QuoteServiceLocator();
        QuoteSoapBindingStub stub = (QuoteSoapBindingStub) l.getQuote();
        return stub.quote("Groucho Marx");
    }
}

restart tomcat, access http://localhost:8080/testquote/index.jsp
if things look weird, try the following: redeploy service, restart tomcat application server, restart operating system.

4 the OperationDesc for was not synchronized to a method ...

When you see this expception, check the following:

do you have the same methodName in .wsdd, your service .java file, and you service call client script?
do you have the same set of parameters?
is there another .jar file in your lib directory that contains an older version of your service java class file, which disables your new class file or jar file?

5 org.apache.axis.InternalException: java.lang.Exception: Couldn't find a matching Java operation for WSDD operation

Check the following:

Did you put the correct operation description in your deploy.wsdd file? For example:

      <operation name="getUserGroups" qname="operNS:getUserGroups" xmlns:operNS="urn:LoginModules" returnQName="getAssignableRolesReturn" returnType="tns:Array" xmlns:rtns="http://schemas.xmlsoap.org/soap/encoding/" soapAction="" >
        <parameter qname="userName" type="tns:string" xmlns:tns="http://schemas.xmlsoap.org/soap/encoding/"/>
        <parameter qname="sessionId" type="tns:string" xmlns:tns="http://schemas.xmlsoap.org/soap/encoding/"/>
      </operation>

Did you put the operation name in the allowedMethods list?

[LM] [UG] [OJ]

6 org.apache.axis.InternalException: java.lang.Exception: Couldn't find a matching Java operation for WSDD operation "xxx" (2 args)

Check the following:

Do you have a method xxx in your axis service java file?
Do you have a correct <operation> pair in your deploy.xml
Do you have xxx in the allowed methods list in deploy.xml?

7 Axis web service instances

Note that Axis creates an instance for each request. For example, in your web service class FooService, you created a database connnection and you thought that it will be reused, NO, because an instance is created for each web service request. So, also remember to disconn from database before returning results to client or you database connections are going to overwhelm the system.

8 Using axis-wsdl2java web service

Here is an example:

<axis-wsdl2java output="src" timeout="-1" testcase="false" verbose="true" url="wsdl/coerterService.wsdl" all="true">
  <mapping namespace="urn:converter" package="com.vmware.converter" />
  <mapping namespace="urn:converterService" package="com.vmware.converter" />
</axis-wsdl2java>

Comments

References

[A] http://ws.apache.org/axis/
[LM] http://www.linux-mag.com/2002-08/axis_01.html
[OJ] http://www.onjava.com/pub/a/onjava/2002/06/05/axis.html
[UG] http://ws.apache.org/axis/java/user-guide.html

||Ax"is (&?;), n. [L.] (Zoöl.) The spotted deer (Cervus axis or Axis maculata) of India, where it is called hog deer and parrah (Moorish name).

Ax"is (&?;), n.; pl. Axes (&?;). [L. axis axis, axle. See Axle.] A straight line, real or imaginary, passing through a body, on which it revolves, or may be supposed to revolve; a line passing through a body or system around which the parts are symmetrically arranged.

2. (Math.) A straight line with respect to which the different parts of a magnitude are symmetrically arranged; as, the axis of a cylinder, i. e., the axis of a cone, that is, the straight line joining the vertex and the center of the base; the axis of a circle, any straight line passing through the center.

3. (Bot.) The stem; the central part, or longitudinal support, on which organs or parts are arranged; the central line of any body. Gray.

4. (Anat.) (a) The second vertebra of the neck, or vertebra dentata. (b) Also used of the body only of the vertebra, which is prolonged anteriorly within the foramen of the first vertebra or atlas, so as to form the odontoid process or peg which serves as a pivot for the atlas and head to turn upon.

5. (Crystallog.) One of several imaginary lines, assumed in describing the position of the planes by which a crystal is bounded.

6. (Fine Arts) The primary or secondary central line of any design.

Anticlinal axis (Geol.), a line or ridge from which the strata slope downward on the two opposite sides. -- Synclinal axis, a line from which the strata slope upward in opposite directions, so as to form a valley. -- Axis cylinder (Anat.), the neuraxis or essential, central substance of a nerve fiber; -- called also axis band, axial fiber, and cylinder axis. -- Axis in peritrochio, the wheel and axle, one of the mechanical powers. -- Axis of a curve (Geom.), a straight line which bisects a system of parallel chords of a curve; called a principal axis, when cutting them at right angles, in which case it divides the curve into two symmetrical portions, as in the parabola, which has one such axis, the ellipse, which has two, or the circle, which has an infinite number. The two axes of the ellipse are the major axis and the minor axis, and the two axes of the hyperbola are the transverse axis and the conjugate axis. -- Axis of a lens, the straight line passing through its center and perpendicular to its surfaces. -- Axis of a telescope or microscope, the straight line with which coincide the axes of the several lenses which compose it. -- Axes of coördinates in a plane, two straight lines intersecting each other, to which points are referred for the purpose of determining their relative position: they are either rectangular or oblique. -- Axes of coördinates in space, the three straight lines in which the coördinate planes intersect each other. -- Axis of a balance, that line about which it turns. -- Axis of oscillation, of a pendulum, a right line passing through the center about which it vibrates, and perpendicular to the plane of vibration. -- Axis of polarization, the central line around which the prismatic rings or curves are arranged. Brewster. -- Axis of revolution (Descriptive Geom.), a straight line about which some line or plane is revolved, so that the several points of the line or plane shall describe circles with their centers in the fixed line, and their planes perpendicular to it, the line describing a surface of revolution, and the plane a solid of revolution. -- Axis of symmetry (Geom.), any line in a plane figure which divides the figure into two such parts that one part, when folded over along the axis, shall coincide with the other part. -- Axis of the equator, ecliptic, horizon (or other circle considered with reference to the sphere on which it lies), the diameter of the sphere which is perpendicular to the plane of the circle. Hutton. -- Axis of the Ionic capital (Arch.), a line passing perpendicularly through the middle of the eye of the volute. - - Neutral axis (Mech.), the line of demarcation between the horizontal elastic forces of tension and compression, exerted by the fibers in any cross section of a girder. - - Optic axis of a crystal, the direction in which a ray of transmitted light suffers no double refraction. All crystals, not of the isometric system, are either uniaxial or biaxial. -- Optic axis, Visual axis (Opt.), the straight line passing through the center of the pupil, and perpendicular to the surface of the eye. -- Radical axis of two circles (Geom.), the straight line perpendicular to the line joining their centers and such that the tangents from any point of it to the two circles shall be equal to each other. -- Spiral axis (Arch.), the axis of a twisted column drawn spirally in order to trace the circumvolutions without. - - Axis of abscissas and Axis of ordinates. See Abscissa.

(search time: 65.05 msec)