Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Web Services with CXF and Eclipse

Warning
titleWatch Out!

This page is out of date, and there is a new approach to developing CXF services with Eclipse! We'll have the details up here as soon as possible.

Introduction

These directions assume that you are familiar with using Eclipse, that you know how to create a war file and that you know how to create a WSDL.

...

You will need to install some extra plugins in eclipse for the Web Services in general, and the CXF Web Services specifically. You can easily download the all-in-one package and extract it to your eclipse folder.
Note: The downloaded package is not the latest version. The latest version of STP(SOA Tools Platform) plugin which integrates the new java2ws tool can only support CXF 2.1.* or higher.

...

After your changes are made and save without any error, a WSDL should appear in the wsdl folder. If it doesn't, use java2wsdl from the CXF package. You can either run it from the command prompt, as an ant task, or from Maven. The
default output directory will be the wsdl directory.

After the WSDL is created, modify to meet your needs. For example, the port is, by default http://localhost:9090/Image Removed. In addition, leaving the parameter named parameters on the input request is not acceptable to .NET code creation routines.

...

Once your WSDL is set, use it to create your implementation class. Highlight the WSDL and right-click. Select JAX-WS Tools/Generate Code. Select Implementation and, if you're using Ant, select Generate Ant Script. If the Impl file isn't created, you can run wsdl2java using the command line, Ant task or maven.

No Format

/**
 * Please modify this class to meet your needs
 * This class is not complete
 */

package com.cid.simpleservice.service;

import java.util.logging.Logger;
import javax.jws.WebMethod;
import javax.jws.WebResult;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;

/**
 * This class was generated by the CXF 2.0.1-incubator
 * Mon Sep 17 14:10:36 EDT 2007
 * Generated source version: 2.0.1-incubator
 * 
 */

@javax.jws.WebService(name = "ScientificCalculator", serviceName = "ScientificCalculatorService",
                      portName 
@javax.jws.WebService(name = "ScientificCalculator", serviceName = "ScientificCalculatorService",
                      portName = "ScientificCalculatorPort",
                      targetNamespace = "http://service.simpleservice.cid.com/", 
                      wsdlLocation = "file:wsdl/javaFirstTest.wsdl" ,
		      endpointInterface = "com.cid.simpleservice.service.ScientificCalculator")
                      
public class ScientificCalculatorImpl implements ScientificCalculator {

    private static final Logger LOG = Logger.getLogger(ScientificCalculatorImpl.class.getName());

    /* (non-Javadoc)
     * @see com.cid.simpleservice.service.ScientificCalculator#squareRoot(float  arg0 ,)float  arg1 )*
     */
    public float squareRoot(float arg0,float arg1) { 
        LOG.info("Executing operation squareRoot");
        System.out.println(arg0);
        System.out.println(arg1);
        try {
   
            float _return = 0.0f;
            return _return;
        } catch (Exception ex) {
            ex.printStackTrace();
            throw new RuntimeException(ex);
        }
    }

}

...

Modify your implementation classes to reflect your actual methods.

Deploying Project

Select File/New/Other/SOA Tools Deployment Profile. Walk through the selections and click Finish. When the editor screen comes up, select the Configuration tab at the bottom. If you didn't add your package when you created the Deployment Profile, click the Add Package button on the right. Select your WSDL from the list, then click OK. Next, click Add Target. Choose your target server, then click OK. Click Create packages at the top of the editor window. This should create your bean definition file and your web.xml file, compile your classes and create the war file.

If the package doesn't create itself, you'll need to manually create the configuration files and war file:

  • Create a beans file for your CXF spring beans. This file needs to go in your WEB-INF directory of your .war file:
No Format

<?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:jaxws="http://cxf.apache.org/jaxws"
	xmlns:soap="http://cxf.apache.org/bindings/soap"
	xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://cxf.apache.org/bindings/soap http://cxf.apache.org/schemas/configuration/soap.xsd
http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd">


	<jaxws:endpoint id="ScientificCalculator_xml_bare"
		implementor="<b>path to your implementation directory</b>"
		wsdlLocation="WEB-INF/wsdl/JavaFirst.wsdl" address="/JavaFirst">
		<jaxws:features>
			<bean class="org.apache.cxf.feature.LoggingFeature" />
		</jaxws:features>
	</jaxws:endpoint>
	

	
</beans>

You may see errors for the endpoint tag. As long as you include the cxf libraries, you can ignore them.

  • You'll also need to create your web.xml file. This can just be cut and paste from this example.
No Format

<?xml version="1.0" encoding="UTF-8"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements. See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership. The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied. See the License for the
  specific language governing permissions and limitations
  under the License.
-->

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
    <display-name>cxf</display-name>
    <description>cxf</description>
    <servlet>
        <servlet-name>cxf</servlet-name>
        <display-name>cxf</display-name>
        <description>Apache CXF Endpoint</description>
        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>cxf</servlet-name>
        <url-pattern>/services/*</url-pattern>
    </servlet-mapping>
    <session-config>
        <session-timeout>60</session-timeout>
    </session-config>
</web-app>

...

Building Package

Right click the WSDL file and select Build Package... in popup menu. Then an war file will be generated in the folder build.

Deploying Package

Right click the WSDL file or the war file and select Deploy... in popup menu. In the popup window, select Tomcat Server you just created above. Then click OK.

Starting Service

Start the Tomcat Server in the Server View. If everything is OK, the service of your project should be activated.
Once you deploy your war file, go to: http://<your server>:<port>/<deployment name>/services. You'll see a link to your wsdl file. Click on it and your wsdl should appear.