Atif Khan’s Blog

POX (Plain Old XML) JAX-WS service using CXF and Spring Configuration

Next Entries
Previous Entries
(Software) Multi-valued Reversible enum in Java
(Programming) Multi-valued Reversible enum in Java
(Java) Multi-valued Reversible enum in Java

By Atif Khan ( January 1, 2008 at 8:22 pm) · Filed under Software, Programming, Java, Web Service

The new and upcoming Apache CXF framework is quickly gaining steam and rightfully so. It’s very intuitive, simple to use and functional. Some of it comes from the fact the its roots are in popular XFire and Celtix frameworks. It’s still in the incubation stage at Apache but the current releases are pretty stable. The documentation is not complete right now, but it’s improving as well.

One of the cases where I found the document and example lacking is the POX (Plain Old XML) service using JAX-WS Provider model and configuring it using Spring. The examples are mainly focussed towards configuring and starting the service from Java code. So, I created this simple EchoService example that shows step by step how to do it.

First step is to create the service Java class that will echo the incoming XML message back to the requester. We will also annotate this class using the JAX-WS annotation to mark it as a web service provider and the message type to be the payload. So, the CXF implementation knows that it should only deliver the message payload to the service class. The CXF binding layer processes any binding level wrappers and headers.

In the above class we specified that we want to receive the incoming XML message as DOM. You can change it to use any concrete subclass of the Source interface (e.g. SAXSource).

Next step is to create the Spring configuration. For simplicity sake, let’s keep the name of this file to applicationContext.xml. Here is an example:

<jaxws:endpoint id="echoService" implementor="test.jws.provider.EchoService"
    address="/echo" bindingUri="http://www.w3.org/2004/08/wsdl/http">
    <jaxws:serviceFactory>
      <bean class="org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean">
        <property name="wrapped" value="true" />
      </bean>
    </jaxws:serviceFactory>
  </jaxws:endpoint>
  
</beans>

The key things to notice in the above XML are:

Address of the service (/echo).
Binding URI (http://www.w3.org/2004/08/wsdl/http). This is really important. This is what tells CXF that this service is going to be simple XML over HTTP.
Declaration of service factor where we indicate that the messages are going to be of wrapped nature

All that’s remaining is to declare the Spring context listener in your web.xml for the web application that this service is going to be a part of. Here is an example of the web.xml: <web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/*</url-pattern> </servlet-mapping> </web-app>

As you can see that there is nothing special here at all. It’s all standard Spring configuration using the context loader listener. Also, we are declaring the CXF servlet here and mapping it to /* to make all the requests to this web application go through the CXF servlet.

Now all you have to do is to package this web application and deploy it in your favorite application server. You should be able to access the Echo Service we wrote at http://localhost:8080/AppName/echo (you will have to adjust the port and application name in the URL). Now HTTP post a XML to this URL and you should get the request echoed back to you.

Maven POM
I think it’s more useful to also specify the Maven POM that contains all the dependencies as well to build the run this example. Please keep in mind that some of the dependencies here may not be required anymore as I was playing around with a lot of CXF functionalities. < ?xml version="1.0" encoding="UTF-8"?> <project> <modelversion>4.0.0</modelversion> <groupid>CXFTest</groupid> <artifactid>CXFTest</artifactid> <packaging>war</packaging> <version>0.0.1</version> <repositories> <repository> <id>apache.incubating.releases</id> <name> Apache Incubating Release Distribution Repository </name> <url> http://people.apache.org/repo/m2-incubating-repository </url> </repository> </repositories> <properties> <spring .version>2.0.7</spring> <cxf .version>2.0.3-incubator</cxf> </properties> <dependencies>  <dependency> <groupid>org.springframework</groupid> <artifactid>spring-core</artifactid> <version>${spring.version}</version> </dependency> <dependency> <groupid>org.springframework</groupid> <artifactid>spring-beans</artifactid> <version>${spring.version}</version> </dependency> <dependency> <groupid>org.springframework</groupid> <artifactid>spring-context</artifactid> <version>${spring.version}</version> </dependency> <dependency> <groupid>org.springframework</groupid> <artifactid>spring-web</artifactid> <version>${spring.version}</version> </dependency> <dependency> <groupid>log4j</groupid> <artifactid>log4j</artifactid> <version>1.2.14</version> </dependency>  <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-core</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-frontend-simple</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-frontend-jaxws</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-databinding-aegis</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-transports-local</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-transports-http</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-transports-http-jetty</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-transports-jms</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-management</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-common-utilities</artifactid> <version>${cxf.version}</version> </dependency> <dependency> <groupid>org.mortbay.jetty</groupid> <artifactid>jetty</artifactid> <version>6.1.5</version> </dependency> <dependency> <groupid>junit</groupid> <artifactid>junit</artifactid> <version>3.8.2</version> <scope>test</scope> </dependency> <dependency> <groupid>org.apache.cxf</groupid> <artifactid>cxf-rt-bindings-http</artifactid> <version>${cxf.version}</version> </dependency> </dependencies> <build> <plugins> <plugin> <artifactid>maven-compiler-plugin</artifactid> <configuration> <source>1.6</source> <target>1.6</target> </configuration> </plugin> </plugins> </build> </project>

Here is a list of all the jar files that ended up being in the war file from the build using above Maven POM. Again, some of the jars here may not be needed. XmlSchema-1.3.2.jar jaxb-impl-2.0.5.jar aopalliance-1.0.jar jaxb-xjc-2.0.jar avalon-framework-4.1.3.jar jaxen-1.1.jar commons-lang-2.1.jar jaxws-api-2.0.jar commons-logging-1.1.jar jdom-1.0.jar cxf-api-2.0.3-incubator.jar jetty-6.1.5.jar cxf-common-schemas-2.0.3-incubator.jar jetty-util-6.1.5.jar cxf-common-utilities-2.0.3-incubator.jar jra-1.0-alpha-4.jar cxf-rt-bindings-http-2.0.3-incubator.jar log4j-1.2.14.jar cxf-rt-bindings-soap-2.0.3-incubator.jar logkit-1.0.1.jar cxf-rt-bindings-xml-2.0.3-incubator.jar neethi-2.0.2.jar cxf-rt-core-2.0.3-incubator.jar saaj-api-1.3.jar cxf-rt-databinding-aegis-2.0.3-incubator.jar saaj-impl-1.3.jar cxf-rt-databinding-jaxb-2.0.3-incubator.jar servlet-api-2.3.jar cxf-rt-frontend-jaxws-2.0.3-incubator.jar servlet-api-2.5-6.1.5.jar cxf-rt-frontend-simple-2.0.3-incubator.jar slf4j-api-1.3.1.jar cxf-rt-management-2.0.3-incubator.jar slf4j-jdk14-1.3.1.jar cxf-rt-transports-http-2.0.3-incubator.jar spring-beans-2.0.7.jar cxf-rt-transports-http-jetty-2.0.3-incubator.jar spring-context-2.0.7.jar cxf-rt-transports-jms-2.0.3-incubator.jar spring-core-2.0.7.jar cxf-rt-transports-local-2.0.3-incubator.jar spring-web-2.0.7.jar cxf-tools-common-2.0.3-incubator.jar stax-api-1.0.1.jar geronimo-activation_1.1_spec-1.0-M1.jar stax-utils-20060502.jar geronimo-annotation_1.0_spec-1.1.jar velocity-1.4.jar geronimo-javamail_1.4_spec-1.0-M1.jar velocity-dep-1.4.jar geronimo-jms_1.1_spec-1.1.jar wsdl4j-1.6.1.jar geronimo-servlet_2.5_spec-1.1-M1.jar wstx-asl-3.2.1.jar geronimo-ws-metadata_2.0_spec-1.1.1.jar xml-apis-1.3.02.jar jaxb-api-2.0.jar xml-resolver-1.2.jar

Share and Enjoy:
These icons link to social bookmarking sites where readers can share and discover new web pages.

Permalink

2 Comments

Kevin said,

January 4, 2008 @ 10:58 am

I’m having difficulty getting this to run and I’m sure it is because I’m a newby to some of the concepts. I’ve gotten other very simple ‘hello’ services to run, but get this error when trying this example:

SEVERE: Context initialization failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with name ‘echoService’: Invocation of init method failed; nested exception is org.apache.cxf.service.factory.ServiceConstructionException: Could not resolve a binding for http://www.w3.org/2004/08/wsdl/http
Caused by: org.apache.cxf.service.factory.ServiceConstructionException: Could not resolve a binding for http://www.w3.org/2004/08/wsdl/http

I can see (http://www.we.org/2004/08/wsdl/http) from my browser, but apparently the code (executing in Eclipse) can’t. Any suggestions as to a configuration problem I might have?
Atif Khan said,

January 4, 2008 @ 11:07 pm

Kevin,
You need to verify that the required jar files are in classpath. I will post tomorrow a list of jars needed along with the Maven script listing all dependencies.