Monday, December 29, 2008

Deploying Web Service in Apache AXIS2

The purpose of this article is to talk about how to write web service and deploy it in Apache AXIS2.

First step is downloading and installing apache axis2. There are two ways to use Apache AXIS2.

1. Install AXIS2 as a standalone server using the Standard Binary Distribution.
2. Deploy axis2.war and deploy it in a servlet container.

We will be using the 2nd method in the article. To check the installation open the url http://localhost:8080/axis2 and you should be able to see the home page of apache axis2.

Please locate the folder axis2\WEB-INF\services in exploded war file of axis2. This is the folder where you will copy the code of your service and it will get deployed in apache axis2.

Lets us take a simple example. Write your service class.

public class HelloWorld
public String sayHello(String firstName, String lastName)
System.out.println("Hello World Invoked");
MessageContext incomingContext = MessageContext.getCurrentMessageContext();
FileDataSource dataSource = new FileDataSource("c:/YServer.txt");
DataHandler dataHandler = new DataHandler(dataSource);
incomingContext.addAttachment("contentID", dataHandler);

String data = DataProvider.getData();
return "Hello " + firstName + " " + lastName + " " + data;
public String getServiceName()
return "test service";

Write a services.xml file.

This is my first service, which says hello
<parameter name="ServiceClass">HelloWorld</parameter>
<operation name="sayHello">
<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
<operation name="getServiceName">
<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>

In case you want to receive the SOAP payload as XML Message in the service you need to specify XML Message receiver instead of RPCMessageReceiver in services.xml file. To specify XML Message receiver put the following line as child of <operation> tag in your services.xml.



Also, since the service will receive XML Message as input parameter you need to change the signature of the method of service.

public OMElement sayHello(OMElement element)

OMElement object contains the XML Message, OMElement Object is provided by AXIOM. AXIOM stands for AXis Object Model (also known as OM - Object Model) and refers to the XML infoset model that was initially developed for Apache Axis2.

Bundle your class file, services.xml in the hierarchy as shown in the figure below. See helloworld folder in image below.

Copy your service into the services folder of axis2 as shown in figure, start web server. Open the URL http://localhost:8080/axis2.

On the displayed page Click on services, you should be able to see the name of service you specified in services.xml in the list of web services.

No comments:

Post a Comment