Axis2 tutorial (5) Annotation based web service

V Bottom up java web service

Build a full web service with Axis2

Java annotation for web services

Since JDK 5.0 it is possible to use java annotations to expose java functions and methods as a web service. In a bottom up web service, the goal is to build a web service from a existing service implementation instead of building a web service from a wsdl file.

Create a new Dynamic Web Project and add the cd-catalog.jar into the WEB-INF/lib directory. Use the CDDaoAxisImpl.java and CDServiceAxisImpl.java files.

The @WebService javax.jws annotation allow to declare our CDServiceAxisImpl.java implementation as a web service as follows :

CDServiceAxisImpl.java

package axis2.tutorial.service;

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

import javax.jws.WebService;

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;

@WebService
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;
	}

}

Server generation

To generate the Axis2 java code that handle our web service declaration, right click on the annotated CDServiceAxisImpl.java file in the Project Explorer and choose Web Services > Create Web service.

Choose Install service in the top left spinner, and select :

the target Server (Tomcat)
the target Web service runtime (Axis2)
the Service project (Axis2TutorialServer)

Bottom up Axis2 web service generation

Start the server and check the generated wsdl at http://localhost:8080/Axis2TutorialServer/services/CDServiceAxisImplService?wsdl. If your service is up and running you should see something like this :

CDServiceAxisImplService.wsdl

<wsdl:definitions
	xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
	xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
	xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
	xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
	xmlns:ns1="http://org.apache.axis2/xsd"
	xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
	xmlns:ax21="http://exception.catalog.cd/xsd"
	xmlns:ns="http://service.tutorial.axis"
	xmlns:xs="http://www.w3.org/2001/XMLSchema"
	xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
	xmlns:ax24="http://mapping.catalog.cd/xsd"
	targetNamespace="http://service.tutorial.axis">
	<wsdl:documentation>
		Please Type your service description here 
	</wsdl:documentation>
	<wsdl:types>
		<xs:schema 
			xmlns:ax25="http://mapping.catalog.cd/xsd"
			xmlns:ax23="http://exception.catalog.cd/xsd"
			attributeFormDefault="qualified"
			elementFormDefault="qualified"
			targetNamespace="http://service.tutorial.axis">
			<xs:import namespace="http://exception.catalog.cd/xsd" />
			<xs:import namespace="http://mapping.catalog.cd/xsd" />
			<xs:complexType name="Exception">
				<xs:sequence>
					<xs:element minOccurs="0" name="Exception" nillable="true" type="xs:anyType" />
				</xs:sequence>
			</xs:complexType>
			<xs:element name="CDServiceException">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="CDServiceException" nillable="true" type="ax21:CDServiceException" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="addToCatalog">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" nillable="true" type="ax24:CD" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="addToCatalogResponse">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="return" nillable="true" type="ax24:CD" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="getById">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" type="xs:long" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="getByIdResponse">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="return" nillable="true" type="ax24:CD" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="updateInCatalog">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" nillable="true" type="ax24:CD" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="updateInCatalogResponse">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="return" nillable="true" type="ax24:CD" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="listByArtist">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" nillable="true" type="xs:string" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="listByArtistResponse">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="return" nillable="true" type="xs:anyType" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="listByName">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" nillable="true" type="xs:string" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="listByNameResponse">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="return" nillable="true" type="xs:anyType" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="searchByCriteria">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" nillable="true" type="xs:string" />
						<xs:element minOccurs="0" name="arg1" nillable="true" type="xs:string" />
						<xs:element minOccurs="0" name="arg2" nillable="true" type="xs:dateTime" />
						<xs:element minOccurs="0" name="arg3" nillable="true" type="xs:dateTime" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="searchByCriteriaResponse">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="return" nillable="true" type="xs:anyType" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
			<xs:element name="removeFromCatalog">
				<xs:complexType>
					<xs:sequence>
						<xs:element minOccurs="0" name="arg0" nillable="true" type="ax24:CD" />
					</xs:sequence>
				</xs:complexType>
			</xs:element>
		</xs:schema>
		<xs:schema xmlns:ax22="http://service.tutorial.axis" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://exception.catalog.cd/xsd">
			<xs:import namespace="http://service.tutorial.axis" />
			<xs:complexType name="CDServiceException">
				<xs:complexContent>
					<xs:extension base="ax22:Exception">
						<xs:sequence />
					</xs:extension>
				</xs:complexContent>
			</xs:complexType>
		</xs:schema>
		<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://mapping.catalog.cd/xsd">
			<xs:complexType name="CD">
				<xs:sequence>
					<xs:element minOccurs="0" name="artistName" nillable="true" type="xs:string" />
					<xs:element minOccurs="0" name="id" nillable="true" type="xs:long" />
					<xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
					<xs:element minOccurs="0" name="publishDate" nillable="true" type="xs:dateTime" />
				</xs:sequence>
			</xs:complexType>
		</xs:schema>
	</wsdl:types>
	<wsdl:message name="searchByCriteriaRequest">
		<wsdl:part name="parameters" element="ns:searchByCriteria" />
	</wsdl:message>
	<wsdl:message name="searchByCriteriaResponse">
		<wsdl:part name="parameters" element="ns:searchByCriteriaResponse" />
	</wsdl:message>
	<wsdl:message name="CDServiceException">
		<wsdl:part name="parameters" element="ns:CDServiceException" />
	</wsdl:message>
	<wsdl:message name="removeFromCatalogRequest">
		<wsdl:part name="parameters" element="ns:removeFromCatalog" />
	</wsdl:message>
	<wsdl:message name="addToCatalogRequest">
		<wsdl:part name="parameters" element="ns:addToCatalog" />
	</wsdl:message>
	<wsdl:message name="addToCatalogResponse">
		<wsdl:part name="parameters" element="ns:addToCatalogResponse" />
	</wsdl:message>
	<wsdl:message name="updateInCatalogRequest">
		<wsdl:part name="parameters" element="ns:updateInCatalog" />
	</wsdl:message>
	<wsdl:message name="updateInCatalogResponse">
		<wsdl:part name="parameters" element="ns:updateInCatalogResponse" />
	</wsdl:message>
	<wsdl:message name="getByIdRequest">
		<wsdl:part name="parameters" element="ns:getById" />
	</wsdl:message>
	<wsdl:message name="getByIdResponse">
		<wsdl:part name="parameters" element="ns:getByIdResponse" />
	</wsdl:message>
	<wsdl:message name="listByArtistRequest">
		<wsdl:part name="parameters" element="ns:listByArtist" />
	</wsdl:message>
	<wsdl:message name="listByArtistResponse">
		<wsdl:part name="parameters" element="ns:listByArtistResponse" />
	</wsdl:message>
	<wsdl:message name="listByNameRequest">
		<wsdl:part name="parameters" element="ns:listByName" />
	</wsdl:message>
	<wsdl:message name="listByNameResponse">
		<wsdl:part name="parameters" element="ns:listByNameResponse" />
	</wsdl:message>
	<wsdl:portType name="CDServiceAxisImplServicePortType">
		<wsdl:operation name="searchByCriteria">
			<wsdl:input message="ns:searchByCriteriaRequest" wsaw:Action="urn:searchByCriteria" />
			<wsdl:output message="ns:searchByCriteriaResponse" wsaw:Action="urn:searchByCriteriaResponse" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:searchByCriteriaCDServiceException" />
		</wsdl:operation>
		<wsdl:operation name="removeFromCatalog">
			<wsdl:input message="ns:removeFromCatalogRequest" wsaw:Action="urn:removeFromCatalog" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:removeFromCatalogCDServiceException" />
		</wsdl:operation>
		<wsdl:operation name="addToCatalog">
			<wsdl:input message="ns:addToCatalogRequest" wsaw:Action="urn:addToCatalog" />
			<wsdl:output message="ns:addToCatalogResponse" wsaw:Action="urn:addToCatalogResponse" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:addToCatalogCDServiceException" />
		</wsdl:operation>
		<wsdl:operation name="updateInCatalog">
			<wsdl:input message="ns:updateInCatalogRequest" wsaw:Action="urn:updateInCatalog" />
			<wsdl:output message="ns:updateInCatalogResponse" wsaw:Action="urn:updateInCatalogResponse" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:updateInCatalogCDServiceException" />
		</wsdl:operation>
		<wsdl:operation name="getById">
			<wsdl:input message="ns:getByIdRequest" wsaw:Action="urn:getById" />
			<wsdl:output message="ns:getByIdResponse" wsaw:Action="urn:getByIdResponse" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:getByIdCDServiceException" />
		</wsdl:operation>
		<wsdl:operation name="listByArtist">
			<wsdl:input message="ns:listByArtistRequest" wsaw:Action="urn:listByArtist" />
			<wsdl:output message="ns:listByArtistResponse" wsaw:Action="urn:listByArtistResponse" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:listByArtistCDServiceException" />
		</wsdl:operation>
		<wsdl:operation name="listByName">
			<wsdl:input message="ns:listByNameRequest" wsaw:Action="urn:listByName" />
			<wsdl:output message="ns:listByNameResponse" wsaw:Action="urn:listByNameResponse" />
			<wsdl:fault message="ns:CDServiceException" name="CDServiceException" wsaw:Action="urn:listByNameCDServiceException" />
		</wsdl:operation>
	</wsdl:portType>
	<wsdl:binding name="CDServiceAxisImplServiceSoap11Binding" type="ns:CDServiceAxisImplServicePortType">
		<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" />
		<wsdl:operation name="searchByCriteria">
			<soap:operation soapAction="urn:searchByCriteria" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="removeFromCatalog">
			<soap:operation soapAction="urn:removeFromCatalog" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="addToCatalog">
			<soap:operation soapAction="urn:addToCatalog" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="updateInCatalog">
			<soap:operation soapAction="urn:updateInCatalog" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="getById">
			<soap:operation soapAction="urn:getById" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="listByName">
			<soap:operation soapAction="urn:listByName" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="listByArtist">
			<soap:operation soapAction="urn:listByArtist" style="document" />
			<wsdl:input>
				<soap:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
	</wsdl:binding>
	<wsdl:binding name="CDServiceAxisImplServiceSoap12Binding" type="ns:CDServiceAxisImplServicePortType">
		<soap12:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" />
		<wsdl:operation name="searchByCriteria">
			<soap12:operation soapAction="urn:searchByCriteria" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap12:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="removeFromCatalog">
			<soap12:operation soapAction="urn:removeFromCatalog" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="addToCatalog">
			<soap12:operation soapAction="urn:addToCatalog" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap12:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="updateInCatalog">
			<soap12:operation soapAction="urn:updateInCatalog" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap12:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="getById">
			<soap12:operation soapAction="urn:getById" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap12:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="listByName">
			<soap12:operation soapAction="urn:listByName" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap12:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
		<wsdl:operation name="listByArtist">
			<soap12:operation soapAction="urn:listByArtist" style="document" />
			<wsdl:input>
				<soap12:body use="literal" />
			</wsdl:input>
			<wsdl:output>
				<soap12:body use="literal" />
			</wsdl:output>
			<wsdl:fault name="CDServiceException">
				<soap12:fault use="literal" name="CDServiceException" />
			</wsdl:fault>
		</wsdl:operation>
	</wsdl:binding>
	<wsdl:binding name="CDServiceAxisImplServiceHttpBinding" type="ns:CDServiceAxisImplServicePortType">
		<http:binding verb="POST" />
		<wsdl:operation name="searchByCriteria">
			<http:operation location="CDServiceAxisImplService/searchByCriteria" />
			<wsdl:input>
				<mime:content type="text/xml" part="searchByCriteria" />
			</wsdl:input>
			<wsdl:output>
				<mime:content type="text/xml" part="searchByCriteria" />
			</wsdl:output>
		</wsdl:operation>
		<wsdl:operation name="removeFromCatalog">
			<http:operation location="CDServiceAxisImplService/removeFromCatalog" />
			<wsdl:input>
				<mime:content type="text/xml" part="removeFromCatalog" />
			</wsdl:input>
		</wsdl:operation>
		<wsdl:operation name="addToCatalog">
			<http:operation location="CDServiceAxisImplService/addToCatalog" />
			<wsdl:input>
				<mime:content type="text/xml" part="addToCatalog" />
			</wsdl:input>
			<wsdl:output>
				<mime:content type="text/xml" part="addToCatalog" />
			</wsdl:output>
		</wsdl:operation>
		<wsdl:operation name="updateInCatalog">
			<http:operation location="CDServiceAxisImplService/updateInCatalog" />
			<wsdl:input>
				<mime:content type="text/xml" part="updateInCatalog" />
			</wsdl:input>
			<wsdl:output>
				<mime:content type="text/xml" part="updateInCatalog" />
			</wsdl:output>
		</wsdl:operation>
		<wsdl:operation name="getById">
			<http:operation location="CDServiceAxisImplService/getById" />
			<wsdl:input>
				<mime:content type="text/xml" part="getById" />
			</wsdl:input>
			<wsdl:output>
				<mime:content type="text/xml" part="getById" />
			</wsdl:output>
		</wsdl:operation>
		<wsdl:operation name="listByName">
			<http:operation location="CDServiceAxisImplService/listByName" />
			<wsdl:input>
				<mime:content type="text/xml" part="listByName" />
			</wsdl:input>
			<wsdl:output>
				<mime:content type="text/xml" part="listByName" />
			</wsdl:output>
		</wsdl:operation>
		<wsdl:operation name="listByArtist">
			<http:operation location="CDServiceAxisImplService/listByArtist" />
			<wsdl:input>
				<mime:content type="text/xml" part="listByArtist" />
			</wsdl:input>
			<wsdl:output>
				<mime:content type="text/xml" part="listByArtist" />
			</wsdl:output>
		</wsdl:operation>
	</wsdl:binding>
	<wsdl:service name="CDServiceAxisImplService">
		<wsdl:port name="CDServiceAxisImplServiceHttpSoap11Endpoint" binding="ns:CDServiceAxisImplServiceSoap11Binding">
			<soap:address location="http://localhost:8080/Axis2TutorialServer/services/CDServiceAxisImplService.CDServiceAxisImplServiceHttpSoap11Endpoint/" />
		</wsdl:port>
		<wsdl:port name="CDServiceAxisImplServiceHttpSoap12Endpoint" binding="ns:CDServiceAxisImplServiceSoap12Binding">
			<soap12:address location="http://localhost:8080/Axis2TutorialServer/services/CDServiceAxisImplService.CDServiceAxisImplServiceHttpSoap12Endpoint/" />
		</wsdl:port>
		<wsdl:port name="CDServiceAxisImplServiceHttpEndpoint" binding="ns:CDServiceAxisImplServiceHttpBinding">
			<http:address location="http://localhost:8080/Axis2TutorialServer/services/CDServiceAxisImplService.CDServiceAxisImplServiceHttpEndpoint/" />
		</wsdl:port>
	</wsdl:service>
</wsdl:definitions>

You can see that all of the methods defined in CDServiceAxisImpl.java are available and also that the mapping defined in the wsdl schema directly maps to the cd.catalog.mapping.CD object.

Java Online

V Bottom up java web service

Java annotation for web services

Server generation

Axis Web Service

Frameworks :

Bookmark & share