Axis tutorial (1) Service specification

I Web service specifications

Build a full web service with Axis

Wikipedia definition

A Web Service is defined by the W3C as "a software system designed to support interoperable machine-to-machine interaction over a network". Web services are frequently just Web APIs that can be accessed over a network, such as the Internet, and executed on a remote system hosting the requested services.

- Wikipedia

Webservice illustration - Wikipedia

In a web service, the Service Requester is able to call a function (the service) provided by the service provider somewhere over a network. To allow service requester to call it's services, the service provider published a web service definition - WSDL (Web service Definition Language) file. This file specify all the information needed by a service requester to call the service provider's services.

Required tools

We are now going to see how to build, deploy and test a end to end web service using Axis, Eclipse and Tomcat. In order to build and run the example, you need to install the following pieces of software :

Service specifications

This tutorial use our recurrent example. We will see how to make our CDService Java interface available through web services and how to invoke it. More specifically, we are going to expose the getById method only of our CDService interface.

The Dao implementation we are going to use is a very simple one. It use a Hashtable<Long,CD> as catalog and contains only one CD . Our Service implementation instantiate a Dao object to perform it's getById method.

CDDaoAxisImpl.java

package axis2.tutorial.dao;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Hashtable;
import java.util.List;

import cd.catalog.dao.CDDao;
import cd.catalog.exception.CDDaoException;
import cd.catalog.mapping.CD;

public class CDDaoAxisImpl implements CDDao {

private Hashtable<Long, CD> catalog;
	
	public CDDaoAxisImpl() {
		this.catalog = new Hashtable<Long, CD>();
		SimpleDateFormat sdf = new SimpleDateFormat("dd/MM/yyyy");
		CD entry = new CD();
		entry.setId(new Long(1));
		entry.setName("OK Computer");
		entry.setArtistName("Radiohead");
		try {
			entry.setPublishDate(sdf.parse("21/05/1997"));
		} catch (ParseException e) {
			// --- Change the date here !!!
		}
		catalog.put(entry.getId(), entry);
	}
	
	public CD create(CD arg0) throws CDDaoException {
		// TODO Auto-generated method stub
		return null;
	}

public void delete(CD arg0) throws CDDaoException {
		// TODO Auto-generated method stub
	}

public CD retrieve(Long arg0) throws CDDaoException {
		return catalog.get(arg0);
	}

public List<CD> searchByCriteria(String arg0, String arg1, Date arg2,
			Date arg3) throws CDDaoException {
		// TODO Auto-generated method stub
		return null;
	}

public CD update(CD arg0) throws CDDaoException {
		// TODO Auto-generated method stub
		return null;
	}

}

CDServiceAxisImpl.java

package axis2.tutorial.service;

import java.util.Date;
import java.util.List;

import axis2.tutorial.dao.CDDaoAxisImpl;
import cd.catalog.dao.CDDao;
import cd.catalog.exception.CDDaoException;
import cd.catalog.exception.CDServiceException;
import cd.catalog.mapping.CD;
import cd.catalog.service.CDService;

public class CDServiceAxisImpl implements CDService {

public CDServiceAxisImpl() {}
	
	public CD addToCatalog(CD arg0) throws CDServiceException {
		// TODO Auto-generated method stub
		return null;
	}

public CD getById(Long arg0) throws CDServiceException {
		CDDao cdDao = new CDDaoAxisImpl();
		try {
			return cdDao.retrieve(arg0);
		} catch (CDDaoException e) {
			throw new CDServiceException("Error while trying to retrieve a CD", e);
		}
	}

public List<CD> listByArtist(String arg0) throws CDServiceException {
		// TODO Auto-generated method stub
		return null;
	}

public List<CD> listByName(String arg0) throws CDServiceException {
		// TODO Auto-generated method stub
		return null;
	}

public void removeFromCatalog(CD arg0) throws CDServiceException {
		// TODO Auto-generated method stub
	}

public List<CD> searchByCriteria(String arg0, String arg1, Date arg2,
			Date arg3) throws CDServiceException {
		// TODO Auto-generated method stub
		return null;
	}

public CD updateInCatalog(CD arg0) throws CDServiceException {
		// TODO Auto-generated method stub
		return null;
	}

}

Download the CDDaoAxisImpl.java CDDao implementation
Download the CDServiceAxisImpl.java CDService implementation

Java Online

I Web service specifications

Wikipedia definition

Required tools

Service specifications

Axis Web Service

Frameworks :

Bookmark & share