Creating Web services using Apache CXF (Part 3): Configurations

Web.xml Declarations

We have to declare Spring Context Listener, CXF Servlet, Spring Context Location and URL Mapping.

<?xml version="1.0" encoding="UTF-8"?>
<web-app id="services" version="2.5"
    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">

    <!-- Adding the Spring Context Listener. It will help to init Spring Context -->
    <listener>
        <listener-class> org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>

    <!-- Context file location of Spring -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>

    <!-- CXF Servlet -->
    <servlet>
        <servlet-name>CXFServlet</servlet-name>
        <servlet-class> org.apache.cxf.transport.servlet.CXFServlet
        </servlet-class>
    </servlet>

    <!-- Mapping with a URL Pattern -->
    <servlet-mapping>
        <servlet-name>CXFServlet</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
</web-app>

Application Context configurations

<?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">

    <!-- Load CXF modules from cxf.jar -->
    <import resource="classpath:META-INF/cxf/cxf.xml" />
    <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

    <!-- The service bean -->
    <bean id="productServiceImpl" class="com.your.company.service.ProductServiceImpl" />

    <!-- Aegis data binding -->
    <bean id="aegisBean" class="org.apache.cxf.aegis.databinding.AegisDatabinding"
        scope="prototype" />
    <bean id="aegis-service" class="org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean"
        scope="prototype">
        <property name="dataBinding" ref="aegisBean" />
        <property name="serviceConfigurations">
            <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>

    <!-- Service endpoint -->
    <jaxws:endpoint id="productService"
        implementorClass="com.your.company.service.ProductServiceImpl"
        implementor="#productServiceImpl" address="/productservice">
        <jaxws:serviceFactory>
            <ref bean="aegis-service" />
        </jaxws:serviceFactory>
    </jaxws:endpoint>

        <!-- Enable message logging using the CXF logging feature -->
    <cxf:bus>
        <cxf:features>
            <cxf:logging />
        </cxf:features>
    </cxf:bus>
</beans>