Java(TM) Boutique - Tutorial - Integrating Apache Axis with the Spring Framework

Tutorials : Integrating Apache Axis with the Spring Framework :

Configuring Axis

Now, you need to configure your Axis class and setup the parameters of the Web service. This will require creating a special deploy.wsdd file. You don't need to configure too many of its options, but in case you ever need to, this file is very well documented at Apache Axis' Deployment (WSDD) Reference. For now, however, you will need only a few options:


<deployment xmlns="http://xml.apache.org/axis/wsdd/"
xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">

	<service name="webservice" provider="java:RPC" style="rpc" use="encoded">
			<parameter name="wsdlTargetNamespace"
			 value="urn:soap.springaxis.prokhorenko.us"/>
			 		<parameter name="className"
					 value="us.prokhorenko.springaxis.soap.WebServiceImpl"/>
		<parameter name="allowedMethods" value="*"/>
			</service>

</deployment>

Define the service name as webservice. This name is used to deploy and undeploy an Axis service. className defines the backend implementation class, which is us.prokhorenko.springaxis.soap.WebServiceImpl (WebServiceImpl.java). Use allowedMethods to determine which methods are allowed to be exposed as Web services; in this example, you are allowing everything. At least, wsdlTargetNamespace defines the namespace for this service, which is set to urn:soap.springaxis.prokhorenko.us.
Now, the add Axis configuration to the web.xml file:

	
<servlet>
		<servlet-name>AxisServlet</servlet-name>
		<display-name>Apache-Axis Servlet</display-name>
		<servlet-class>org.apache.axis.transport.http.AxisServlet</servlet-class>
		<load-on-startup>5</load-on-startup>
	</servlet>

	<servlet-mapping>
		<servlet-name>AxisServlet</servlet-name>
		<url-pattern>/soap/*</url-pattern>
	</servlet-mapping>

The most important thing to note is the mapping: the code maps /soap/ to Axis' Web services.

Building Everything

This example uses the Apache Ant tool for building the project into WAR. The build.xml is pretty standard and normally would not require any changes except for the Axis configuration:

	
<target name="prepaxis" depends="compwar">
		<echo message=" **** Preparing Axis "/>
		<java classname="org.apache.axis.utils.Admin"
			fork="true"
			failonerror="true"
			classpathref="compile.class.path"
			dir="${build}\WEB-INF\">
			<arg value="server" />
			<arg file="src/java/us/prokhorenko/springaxis/soap/deploy.wsdd" />
		</java>
	</target>

It sets the file option which points to the deploy.wsdd configuration file. And you may also need to set the proper values in the properties.xml file.

Here's how the sample building and deploying process looks:


Buildfile: build.xml

compwar:
     [echo]  **** Compiling WAR 
    [mkdir] Created dir: C:\white\work\Java\sa\build\WEB-INF\classes
    [javac] Compiling 5 source files to C:\white\work\Java\sa\build\WEB-INF\classes
	
prepaxis:
     [echo]  **** Preparing Axis 
     [java] - Unable to find required classes (javax.activation.DataHandler and
	  javax.mail.internet.MimeMultipart). Attachment support is disabled.
     [java] <?xml version="1.0" encoding="UTF-8"?>
     [java] <Admin>Done processing</Admin>

prepwar:
     [echo]  **** Preparing WAR 

packwar:
     [echo]  **** Packing WAR 
    [mkdir] Created dir: C:\white\work\Java\sa\dist
      [war] Building war: C:\white\work\Java\sa\dist\springaxis.war

all:

deploy:
     [echo]  **** Deploying WAR 
     [copy] Copying 1 file to C:\jakarta-tomcat-5.0.30\webapps

BUILD SUCCESSFUL
Total time: 16 seconds

Now the application is deployed and ready to serve.

Running

The source code for this article includes a sample SOAP client. It will allow you to easily test your Web service configuration and confirm that everything's working as it's supposed to. The client is configured to use the endpoint http://localhost:8080/springaxis/soap/webservice. It calls the doSomeWork() method and passes "TheNameOfWork" as an argument. After building and deploying, you'll be able to run this client at http://localhost:8080/springaxis/SOAP.html

Hopefully, this gives you a detailed and easy-to-repeat tutorial on enabling methods from business logic as Web services.

Resources

Home / Articles / Integrating Apache Axis with the Spring Framework / 1 / 2 / 3

Applet Index
(sorted alphabetically)
A B C D E F G H I J K
L M N O P Q R S T U
V W X Y Z #s

The Java Source
(applets w/source code)
A B C D E F G H I J K
L M N O P Q R S T U
V W X Y Z

How to Add Java Applets to Your Site

New on the Java Boutique:

New Review:

Time Management Made Easy with the Quartz Enterprise Job Scheduler
Why not just use the Java timer API? This open source scheduling API boasts simplicity, ease-of-integration, a well-rounded feature set, and it's free!

New Applet:

Reverse Complement
Reverse Complement is a simple applet that converts DNA or RNA sequences into three useful formats.