CXF Example –Web Service Using Spring and Maven

Apache CXF is an open source services framework. CXF helps you build Web Services using frontend programming APIs, like JAX-WS and JAX-RS. These services can speak a variety of protocols such as SOAP, XML/HTTP, RESTful HTTP, or CORBA and work over a variety of transports such as HTTP, JMS or JBI.

Support for bottom up approach and top down approach.

Support for Standards

JAX-WS, JSR-181, SAAJ, JAX-RS
SOAP 1.1, 1.2, WS-I BasicProfile, WS-Security, WS-Addressing, WS-RM, WS-Policy
WSDL 1.1
MTOM

Building Web Services – Example 1

Develop a simple Web Service using CXF framework.

The example in this case is an InterestRate Service.

Tools / technologies	Version
CXF	2.1
Maven	2.0
Tomcat	apache-tomcat-6.0.24
JDK	java version 1.6.0_20

The Application Scope

The "Interest Rate Service" application demonstrates how easily you can develop a Web Service using CXF frame work. The WSDL service definition defines three operations. Below is the InterestRateService interface.

@WebService

public
interface
InterestRateService {

float getInterestRate (MortgageType type, int term );

Collection <MortgageType> getMortgageTypes ();

void addMortgageType (MortgageType type);

}

Building the Web Service

Create a Maven project as below:
mvn archetype:create -DgroupId=com.mycompany.webservice -DartifactId=rateservice -DarchetypeArtifactId=maven-archetype-webapp
Create implementation class for InterestRateService. See the a portion of the implementation.

/*import statements */

@WebService(endpointInterface = "com.mycompany.webservice.service.InterestRateService")

public
class InterestRateServiceImpl implements InterestRateService {

List<MortgageType> mortgageTypes = new ArrayList<MortgageType>();

public
float
getInterestRate(MortgageType type, int term) {

float
rate = 0.0f;

if (type.equals("CLOSED")) {

if (term == 1) {

rate = 3.9f;

} else
if (term > 1 && term < 5) {

rate = 4.0f;

} else
if (term >= 5 && term < 10) {

rate = 4.9f;

} else
if (term > 10) {

rate = 5.9f;

}

} else
if (type.equals("OPEN")) {

rate = 6.5f;

} else
if (type.equals("CONVERT")) {

rate = 4.9f;

} else
if (type.equals("CASH-BACK")) {

rate = 6.1f;

}

return rate;

}

Define your Web.xml. Note the definition of appContext.xml to define a Spring application context. Also see the how the servlet is defined.

<?xml
version="1.0"
encoding="UTF-8"?>

<web-app
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns="http://java.sun.com/xml/ns/javaee"

xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"

xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"

id="services"
version="2.5">

<context-param>

<param-name>contextConfigLocation</param-name>

<param-value>/WEB-INF/appContext.xml</param-value>

</context-param>

<listener-class>

org.springframework.web.context.ContextLoaderListener

</listener-class>

</listener>

<servlet-name>Servlet</servlet-name>

<servlet-class>

org.apache..transport.servlet.CXFServlet

</servlet-class>

</servlet>

<servlet-mapping>

<servlet-name>CXFServlet</servlet-name>

<url-pattern>/webservices/*</url-pattern>

</servlet-mapping>

</web-app>

Define your appContext.xml where you can hook up to spring instantiated services.

<?xml
version="1.0"
encoding="UTF-8"?>

<beans
xmlns="http://www.springframework.org/schema/beans"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:context="http://www.springframework.org/schema/context"

xmlns:cxf="http://cxf.apache.org/core"

xmlns:jaxws="http://cxf.apache.org/jaxws"

xsi:schemaLocation="http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans-2.5.xsd

http://www.springframework.org/schema/context

http://www.springframework.org/schema/context/spring-context-2.5.xsd

http://cxf.apache.org/core

http://cxf.apache.org/schemas/core.xsd

http://cxf.apache.org/jaxws

http://cxf.apache.org/schemas/jaxws.xsd"

default-autowire="byName">

<cxf:bus>

<cxf:features>

<cxf:logging
/>

</cxf:features>

</cxf:bus>

<bean
id="interestRateServiceImpl"

class="com.mycompany.webservice.service.InterestRateServiceImpl"
/>

<bean
id="aegisBean"

class="org.apache.cxf.aegis.databinding.AegisDatabinding"

scope="prototype"
/>

<bean
id="jaxws-and-aegis-service-factory"

class="org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean"

scope="prototype">

<list>

<bean

class="org.apache.cxf.jaxws.support.JaxWsServiceConfiguration"
/>

<bean

class="org.apache.cxf.aegis.databinding.AegisServiceConfiguration"
/>

<bean

class="org.apache.cxf.service.factory.DefaultServiceConfiguration"
/>

</list>

</property>

</bean>

<jaxws:endpoint
id="interestRateService"

implementorClass="com.mycompany.webservice.service.InterestRateServiceImpl"

implementor="#interestRateServiceImpl"
address="/interestRate">

<jaxws:serviceFactory>

</jaxws:serviceFactory>

</jaxws:endpoint>

</beans>

Build the application. Here is the pom.xml I used to build the application.

<?xml
version="1.0"
encoding="UTF-8"?>

<name>rateservice</name>

<groupId>com.mycompany.webservice</groupId>

<artifactId>rateservice</artifactId>

<cxf.version>2.1.1</cxf.version>

<spring.version>2.5.5</spring.version>

</properties>

<groupId>org.springframework</groupId>

<artifactId>spring</artifactId>

<version>${spring.version}</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context</artifactId>

<version>${spring.version}</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-core</artifactId>

<version>${spring.version}</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-beans</artifactId>

<version>${spring.version}</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

<version>${spring.version}</version>

</dependency>