Apache CXF – Simple WebService With Spring

A reader posted a comment to one of my old blogs on XFire. That rekindled my interest so I checked the XFire web site only to be informed that XFire is now Apache CXF (version 2.2.3 at this moment in time).

So how hard would it be to convert my old example to CXF. Turned out to be a piece of cake. Had to change the following:

Updated the maven dependencies to reflect CXF libraries.
web.xml – to point to the CXF Servlet
Spring context (app-context.xml) – It was now a lot simpler and cleaner.
Finally I used CXF wsdl2java utils to generate a client

Maven pom.xml

1:  &lt;project&gt;
2:    &lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt;
3:    &lt;groupId&gt;com.aver&lt;/groupId&gt;
4:    &lt;artifactId&gt;echo&lt;/artifactId&gt;
5:    &lt;packaging&gt;war&lt;/packaging&gt;
6:    &lt;version&gt;1.0-SNAPSHOT&lt;/version&gt;
7:    &lt;name&gt;CXF Echo Service&lt;/name&gt;
8:    &lt;dependencies&gt;
9:      &lt;dependency&gt;
10:        &lt;groupId&gt;org.springframework&lt;/groupId&gt;
11:        &lt;artifactId&gt;spring&lt;/artifactId&gt;
12:        &lt;version&gt;2.5.6&lt;/version&gt;
13:      &lt;/dependency&gt;
14:      &lt;dependency&gt;
15:        &lt;groupId&gt;org.apache.cxf&lt;/groupId&gt;
16:        &lt;artifactId&gt;cxf-rt-frontend-jaxws&lt;/artifactId&gt;
17:        &lt;version&gt;2.2.3&lt;/version&gt;
18:      &lt;/dependency&gt;
19:      &lt;dependency&gt;
20:        &lt;groupId&gt;org.apache.cxf&lt;/groupId&gt;
21:        &lt;artifactId&gt;cxf-rt-transports-http&lt;/artifactId&gt;
22:        &lt;version&gt;2.2.3&lt;/version&gt;
23:      &lt;/dependency&gt;
24:      &lt;dependency&gt;
25:        &lt;groupId&gt;junit&lt;/groupId&gt;
26:        &lt;artifactId&gt;junit&lt;/artifactId&gt;
27:        &lt;version&gt;4.7&lt;/version&gt;
28:        &lt;scope&gt;test&lt;/scope&gt;
29:      &lt;/dependency&gt;
30:      &lt;dependency&gt;
31:        &lt;groupId&gt;log4j&lt;/groupId&gt;
32:        &lt;artifactId&gt;log4j&lt;/artifactId&gt;
33:        &lt;version&gt;1.2.14&lt;/version&gt;
34:      &lt;/dependency&gt;
35:    &lt;/dependencies&gt;
36:    &lt;build&gt;
37:      &lt;plugins&gt;
38:        &lt;plugin&gt;
39:          &lt;groupId&gt;org.mortbay.jetty&lt;/groupId&gt;
40:          &lt;artifactId&gt;maven-jetty-plugin&lt;/artifactId&gt;
41:          &lt;configuration&gt;
42:            &lt;contextPath&gt;/echoservice&lt;/contextPath&gt;
43:            &lt;connectors&gt;
44:              &lt;connector implementation="org.mortbay.jetty.nio.SelectChannelConnector"&gt;
45:                &lt;port&gt;9090&lt;/port&gt;
46:                &lt;maxIdleTime&gt;60000&lt;/maxIdleTime&gt;
47:              &lt;/connector&gt;
48:            &lt;/connectors&gt;
49:          &lt;/configuration&gt;
50:        &lt;/plugin&gt;
51:        &lt;plugin&gt;
52:          &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
53:          &lt;artifactId&gt;maven-compiler-plugin&lt;/artifactId&gt;
54:          &lt;configuration&gt;
55:            &lt;source&gt;1.5&lt;/source&gt;
56:            &lt;target&gt;1.5&lt;/target&gt;
57:          &lt;/configuration&gt;
58:        &lt;/plugin&gt;
59:      &lt;/plugins&gt;
60:    &lt;/build&gt;
61:  &lt;/project&gt;

1: <project>

2: <modelVersion>4.0.0</modelVersion>

3: <groupId>com.aver</groupId>

4: <artifactId>echo</artifactId>

5: <packaging>war</packaging>

6: <version>1.0-SNAPSHOT</version>

7: <name>CXF Echo Service</name>

8: <dependencies>

9: <dependency>

10: <groupId>org.springframework</groupId>

11: <artifactId>spring</artifactId>

12: <version>2.5.6</version>

13: </dependency>

14: <dependency>

15: <groupId>org.apache.cxf</groupId>

16: <artifactId>cxf-rt-frontend-jaxws</artifactId>

17: <version>2.2.3</version>

18: </dependency>

19: <dependency>

20: <groupId>org.apache.cxf</groupId>

21: <artifactId>cxf-rt-transports-http</artifactId>

22: <version>2.2.3</version>

23: </dependency>

24: <dependency>

25: <groupId>junit</groupId>

26: <artifactId>junit</artifactId>

27: <version>4.7</version>

28: <scope>test</scope>

29: </dependency>

30: <dependency>

31: <groupId>log4j</groupId>

32: <artifactId>log4j</artifactId>

33: <version>1.2.14</version>

34: </dependency>

35: </dependencies>

36: <build>

37: <plugins>

38: <plugin>

39: <groupId>org.mortbay.jetty</groupId>

40: <artifactId>maven-jetty-plugin</artifactId>

41: <configuration>

42: <contextPath>/echoservice</contextPath>

43: <connectors>

44: <connector implementation="org.mortbay.jetty.nio.SelectChannelConnector">

45: <port>9090</port>

46: <maxIdleTime>60000</maxIdleTime>

47: </connector>

48: </connectors>

49: </configuration>

50: </plugin>

51: <plugin>

52: <groupId>org.apache.maven.plugins</groupId>

53: <artifactId>maven-compiler-plugin</artifactId>

54: <configuration>

55: <source>1.5</source>

56: <target>1.5</target>

57: </configuration>

58: </plugin>

59: </plugins>

60: </build>

61: </project>

The web.xml…

1:  &lt;web-app&gt;
2:    &lt;context-param&gt;
3:      &lt;param-name&gt;contextConfigLocation&lt;/param-name&gt;
4:      &lt;param-value&gt;
5:        /WEB-INF/app-context.xml
6:      &lt;/param-value&gt;
7:    &lt;/context-param&gt;
8:    &lt;listener&gt;
9:      &lt;listener-class&gt;
10:        org.springframework.web.context.ContextLoaderListener
11:      &lt;/listener-class&gt;
12:    &lt;/listener&gt;
13:    &lt;servlet&gt;
14:      &lt;servlet-name&gt;CXFServlet&lt;/servlet-name&gt;
15:      &lt;servlet-class&gt;
16:        org.apache.cxf.transport.servlet.CXFServlet
17:      &lt;/servlet-class&gt;
18:    &lt;/servlet&gt;
19:    &lt;servlet-mapping&gt;
20:      &lt;servlet-name&gt;CXFServlet&lt;/servlet-name&gt;
21:      &lt;url-pattern&gt;/services/*&lt;/url-pattern&gt;
22:    &lt;/servlet-mapping&gt;
23:  &lt;/web-app&gt;

1: <web-app>

2: <context-param>

3: <param-name>contextConfigLocation</param-name>

4: <param-value>

5: /WEB-INF/app-context.xml

6: </param-value>

7: </context-param>

8: <listener>

9: <listener-class>

10: org.springframework.web.context.ContextLoaderListener

11: </listener-class>

12: </listener>

13: <servlet>

14: <servlet-name>CXFServlet</servlet-name>

15: <servlet-class>

16: org.apache.cxf.transport.servlet.CXFServlet

17: </servlet-class>

18: </servlet>

19: <servlet-mapping>

20: <servlet-name>CXFServlet</servlet-name>

21: <url-pattern>/services/*</url-pattern>

22: </servlet-mapping>

23: </web-app>

The Spring context file – app-context.xml

1:    &lt;import resource="classpath:META-INF/cxf/cxf.xml" /&gt;
2:    &lt;import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" /&gt;
3:    &lt;import resource="classpath:META-INF/cxf/cxf-servlet.xml" /&gt;
4:    &lt;jaxws:endpoint id="echoService" implementor="#echo"
5:      address="/EchoService" /&gt;
6:    &lt;bean id="echo" class="com.aver.EchoServiceImpl" /&gt;

1: <import resource="classpath:META-INF/cxf/cxf.xml" />

2: <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />

3: <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

4: <jaxws:endpoint id="echoService" implementor="#echo"

5: address="/EchoService" />

6: <bean id="echo" class="com.aver.EchoServiceImpl" />

The wsdl2java command I executed was:

 ./wsdl2java -p com.aver.client -client localhost:9090/echoservice/services/EchoService?wsdl

1 2	./wsdl2java -p com.aver.client -client localhost:9090/echoservice/services/EchoService?wsdl

Run the project using maven: mvn clean package jetty:run

The WSDL is located at the address mentioned above in the wsld2java command.

Finally I ran the test client that wsdl2java generated…class named EchoService_EchoServicePort_Client

The output was:

   Invoking echo...  
   echo.result=echo: 'uyy ' received on 10-07-2009 10:53:59 PM

Invoking echo...

echo.result=echo: 'uyy ' received on 10-07-2009 10:53:59 PM

Click here to download the maven project for this blog.

{"Mat's Random Thoughts"}

Mathew's Tech Notes..

Apache CXF – Simple WebService With Spring