Celtix

Archive: ‘Celtix’ Category

Creating Web Services using CXF (Contract first Approach) Part 2 : WSDL Creation.

5 comments June 15th, 2009 Lijin

What is WSDL and what its Structure?

A WSDL document defines services as collections of network endpoints, or ports. In WSDL, the abstract definition of endpoints and messages is separated from their concrete network deployment or data format bindings. This allows the reuse of abstract definitions: messages, which are abstract descriptions of the data being exchanged, and port types which are abstract collections of operations.

The concrete protocol and data format specifications for a particular port type constitutes a reusable binding. A port is defined by associating a network address with a reusable binding, and a collection of ports define a service. Hence, a WSDL document uses the following elements in the definition of network services:

WSDL document describes a web service using these major elements:

Element	Defines
<types>	The data types used by the web service
<message>	The messages used by the web service
<portType>	The operations performed by the web service
<binding>	The communication protocols used by the web service
<port>	A single endpoint defined as a combination of a binding and a network address.
<service>	A collection of related endpoints.

The main structure of a WSDL document looks like this:

<definitions>
<types>
definition of types……..
</types>
<message>
definition of a message….
</message>
<portType>
definition of a port…….
</portType>
<binding>
definition of a binding….
</binding>

<service>
definition of services….
</service>
</definitions>

A WSDL document can also contain other elements, like extension elements and a service element that makes it possible to group together the definitions of several web services in one single WSDL document.

Creating WSDL for our Example

<types>:In the Types we are defining or configuring the Datatypes which we are using for the entire application. Here we are importing the XSD files here.

<message>:In our example we need to configure our input and our parameters/ the message which we are passing through Webservice. We are configuring request and response objects here.

<portType>: We have one operation which is called getProduct. So here we need to declare this getProduct operation.

<binding> : Here we will be providing our protocol types and we are using SOAP protocol.

<service> : Defining the Service End point. And for the ProductService we are defining it as “http://localhost:8080/ContractFirst/services/ProductService”

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:tns="http://com/your/company/service/ProductService/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="ProductService"
    targetNamespace="http://com/your/company/service/ProductService/"
    xmlns:prd="http://com/your/company/service/Product/">
    <wsdl:types>
        <xsd:schema targetNamespace="http://com/your/company/service/ProductService/"
            xmlns:prd="http://com/your/company/service/Product/">
            <xsd:import namespace="http://com/your/company/service/Product/"
                schemaLocation="../Product.xsd" />
            <xsd:element name="getProductRequest">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="productRequest" type="prd:ProductRequest" />
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
            <xsd:element name="getProductResponse">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="productResponse" type="prd:ProductResponse" />
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
        </xsd:schema>
    </wsdl:types>
    <wsdl:message name="ProductRequest">
        <wsdl:part element="tns:getProductRequest" name="parameters" />
    </wsdl:message>
    <wsdl:message name="ProductResponse">
        <wsdl:part element="tns:getProductResponse" name="parameters" />
    </wsdl:message>
    <wsdl:portType name="ProductService">
        <wsdl:operation name="getProduct">
            <wsdl:input message="tns:ProductRequest" />
            <wsdl:output message="tns:ProductResponse" />
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:binding name="ProductServiceSOAP" type="tns:ProductService">
        <soap:binding style="document"
            transport="http://schemas.xmlsoap.org/soap/http" />
        <wsdl:operation name="getProduct">
            <soap:operation
                soapAction="http://com/your/company/service/ProductService/getProduct" />
            <wsdl:input>
                <soap:body use="literal" />
            </wsdl:input>
            <wsdl:output>
                <soap:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="ProductService">
        <wsdl:port binding="tns:ProductServiceSOAP" name="ProductServiceSOAP">
            <soap:address
                location="http://localhost:8080/ContractFirst/services/ProductService" />
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>

In our next part we will go through Skelton creation using WSDL to Java tool which is giving by CXF.

Popularity: 15% [?]

CXF, Celtix, Spring, Xfire, web, webservices

Creating Web services using Apache CXF (Part 4): Testing

16 comments June 11th, 2009 Lijin

To test this we can follow the same client program which is given in the CXF site.

Just create a simple Java class and execute it.

package com.your.company.service.client;

import java.util.List;

import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;

import com.your.company.service.Product;
import com.your.company.service.ProductService;

public final class Client {

    private Client() {
    }

    public static void main(String args[]) throws Exception {

        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();

        factory.getInInterceptors().add(new LoggingInInterceptor());
        factory.getOutInterceptors().add(new LoggingOutInterceptor());
        factory.setServiceClass(ProductService.class);
        factory.setAddress("http://localhost:8080/CXFExample/productservice");
        ProductService client = (ProductService) factory.create();

        List<Product> products = client.getProducts();
        if (products != null && products.size() > 0)
            System.out.println("Product Name : "
                    + products.get(0).getItemName() + ", Price: "
                    + products.get(0).getPrice());
        System.exit(0);

    }

}

Other related posts:

1. Creating Web services using Apache CXF (Part 1) : The Basics .

2. Creating Web services using Apache CXF (Part 2) : Development.

3. Creating Web services using Apache CXF (Part 3) : Configuration.

4. Creating Web services using Apache CXF (Part 4): Testing.

Popularity: 17% [?]

CXF, Celtix, Web Applications, Xfire, apache, web, webservices

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

13 comments June 11th, 2009 Lijin

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>

Create a WAR out of this Project and deploy it in Apache Tomcat. And try to access the WSDL URL

http://localhost:8080/CXFExample/ProductService?wsdl.

Other related posts:

1. Creating Web services using Apache CXF (Part 1) : The Basics .

2. Creating Web services using Apache CXF (Part 2) : Development.

3. Creating Web services using Apache CXF (Part 3) : Configuration.

4. Creating Web services using Apache CXF (Part 4): Testing.

Popularity: 22% [?]

CXF, Celtix, apache, web, webservices

Creating Web services using Apache CXF (Part 2): Development

15 comments June 10th, 2009 Lijin

We need to set-up the project environment first. Please download the following JARs.

Versions Used :

CXF 2.2.2 Download Link : CXF Site Download Link

Spring 2.5.6 Download Link : SpringSource Download site

The following jars are required for all CXF usage: But you will be getting it through CXF Download.
- cxf.jar
- commons-logging.jar
- geronimo-activation.jar (Or the Sun equivalent) [6]
- geronimo-annotation.jar (Or the Sun equivalent) [6]
- geronimo-javamail.jar (Or the Sun equivalent) [6]
- geronimo-stax-api.jar (Or the Sun equivalent) [6]
- neethi.jar
- jaxb-api.jar [6]
- jaxb-impl.jar
- XmlSchema.jar
- wstx-asl.jar [6]
- wsdl4j.jar

The following jars are required for XML catalog support:
- xml-resolver.jar

For Java2WSDL and WSDL2Java:
- The above jars
- jaxb-xjc.jar
- velocity.jar
- commons-collections.jar
- commons-lang.jar

For JAX-WS support:
- geronimo-ws-metadata.jar [6]
- geronimo-jaxws_2.1_spec-1.0.jar (Or the Sun equivalent) [6]
- saaj-api.jar [6]
- saaj-impl.jar [6]
- asm.jar (semi-optional, helps with performance of wrapper types and is
required when adding JAXB annotations onto the SEI methods and
parameters.)

For XML Configuration support:
- aopalliance.jar
- spring-beans.jar
- spring-context.jar
- spring-core.jar
- spring.web.jar
- FastInfoset.jar

For standalone HTTP support:
- geronimo-servlet.jar
- jetty.jar
- jetty-util.jar
- sl4j.jar & sl4j-jdk14.jar (optional – but improves logging)
For Aegis support:
- jdom.jar (optional, if you want to map xsd:anyType to JDOM)

For WS-Security support:
- bcprov-jdk15.jar
- xalan.jar
- serializer.jar
- wss4j.jar
- xmlsec.jar

For HTTP Binding support:
- jra.jar
- jettison.jar (Needed for JSON services only)

For JAX-RS support:
- abdera*
- axiom*
- jsr311-api.jar
- jettison.jar (Needed for JSON services only)

For JMS transport
- geronimo-jms.jar (Or the Sun equivalent)
- spring-jms.jar

For CORBA support:
- antlr.jar

If you want to use Aegis databinding which is providing by CXF then:

Download :jdom-1.0.jar

For Spring you can download its latest version say 2.5.

Step 2: Creating a Project

Open your IDE ( I am using Eclipse) and create a Web project. Lets say with Name CXFExample.

Create a package say “com.your.company.service”
Create a POJO class with a name say “Product”. And include some properties like productName etc.

package com.your.company.service;

import org.apache.cxf.aegis.type.java5.IgnoreProperty;

public final class Product {
    private String itemName;
    private String category;
    private double price;
    private String details;

    public Product() {
    }

    public Product(String itemName, String category, double price,
            String details) {
        this.itemName = itemName;
        this.category = category;
        this.price = price;
        this.details = details;
    }

    public String getItemName() {
        return itemName;
    }

    public void setItemName(String itemName) {
        this.itemName = itemName;
    }

    public String getCategory() {
        return category;
    }

    public void setCategory(String category) {
        this.category = category;
    }

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    @IgnoreProperty
    public String getDetails() {
        return details;
    }

    public void setDetails(String details) {
        this.details = details;
    }

}

Note that we used one Annotation from Aegis. Its just to get some idea about that annotation. As you know Aegis is using for data binding. As the annotation denotes if we are mentioning it is not needed in the WSDL file.

Creating the Service Interface

package com.your.company.service;

import java.util.List;

import javax.jws.WebParam;
import javax.jws.WebService;

@WebService
public interface ProductService {

    List<Product> getProducts();

    void addProduct(@WebParam(name = "product") Product product);

    public void addProducts(@WebParam(name = "products") List<Product> products);

}

Here we are using @WebService annotation and @WebParam Annotations. They are JAX-WS annotations.

@WebService is using to denote this Interface as the Web Service Interface. So while creating WSDL file this will consider.

@WebParam is using to name the Arguments in the WSDL file. Default it will be like Arg0, Arg1 etc. But if we are giving some names then that will be more identifiable in the WSDL.

Create the Service Implementation class

package com.your.company.service;

import java.util.ArrayList;
import java.util.List;

import javax.jws.WebParam;
import javax.jws.WebService;

@WebService(endpointInterface = "edu.web.service.ProductService")
public final class ProductServiceImpl implements ProductService {

    public List<Product> getProducts() {
        List<Product> products = new ArrayList<Product>();
        products.add(new Product("SpringInAction", "Manning", 200,
                "Book about Spring"));
        products.add(new Product("EJB3InAction", "Manning", 200,
                "Book about EJB3"));
        return products;
    }

    @Override
    public void addProduct(Product product) {
        System.out.println(product);
    }

    @Override
    public void addProducts(@WebParam(name = "products") List<Product> products) {
        for (Product product : products) {
            System.out.println(product);
        }
    }
}

Here we are writing the Impls of our Interface methods. @WebService annotation is marking this class as a web service implementation

In the next PART we will be discussing about the Configurations.

Other related posts:

1. Creating Web services using Apache CXF (Part 1) : The Basics .

2. Creating Web services using Apache CXF (Part 2) : Development.

3. Creating Web services using Apache CXF (Part 3) : Configuration.

4. Creating Web services using Apache CXF (Part 4): Testing.

Popularity: 24% [?]

CXF, Celtix, Xfire, apache, web, webservices

Creating Web services using Apache CXF (Part 1) : The Basics.

16 comments June 10th, 2009 Lijin

As we discussed in the previous post, CXF is the combination of two projects: Celtix developed by IONA and XFire developed by Codehaus working together at the Apache Software Foundation.

If you want an Enterprise support for CXF then please find the following links.

Open Source FUSE Services Framework – based on CXF

FUSE open source community

FUSE Forums

CXF Developer Advantages

If you know Spring then CXF is too easy for you. All its configurations are in a Spring xml file. Internally CXF is reading this Spring XML as its Configuration file.JAX-WS encompasses many different areas:
- Generating WSDL from Java classes and generating Java classes from WSDL
- Provider API which allows you to create simple messaging receiving server endpoints
- Dispatch API which allows you to send raw XML messages to server endpoints
CXF implements the JAX-WS APIs which make building web services easy.
Aegis Databinding (2.0.x) is a databinding library that makes development of code-first web services incredibly easy.
CXF enables the development of RESTful services via annotations using the HTTP Binding.

It has a lot many features more to say. Once you got your project requirements and clear with the approach which you want to follow then please have a look on this feature list. I think you definitely will choose CXF without any doubt. [I am exerting some of the features from its own site]

General

High Performance
Extensible
Intuitive & Easy to Use

Support for Standards

JAX-WS, JAX-WSA, JSR-181, and SAAJ
SOAP 1.1, 1.2, WS-I Basic Profile, WS-Security, WS-Addressing, WS-RM and WS-Policy
WSDL 1.1 and 2.0
MTOM

Multiple Transports, Bindings, Data Bindings, and Formats

Bindings: SOAP, REST/HTTP
Data bindings: JAXB 2.0, Aegis, XMLBeans. (Castor and JiBX will be supported in a later version of CXF)
Formats: XML, JSON
Transports: HTTP, Servlet, JMS, and Jabber transports
Extensibility API allows additional bindings for CXF, enabling additional message format support such as CSV and fixed record length

Flexible Deployment

Lightweight containers: deploy services in Tomcat or Spring-based containers
JBI integration: deploy as a service engine in a JBI container such as ServiceMix, OpenESB or Petals
SCA integration: deploy in an SCA container such as Tuscany
J2EE integration: deploy services in J2EE application servers such as Geronimo, JOnAS, JBoss, WebLogic, and WebSphere
Standalone Java client/server