Apache Authors: Elizabeth White, Pat Romanski, Liz McMillan, Christopher Harrold, Janakiram MSV

Related Topics: ColdFusion, Apache

ColdFusion: Article

Web Services Using ColdFusion and Apache CXF

Enabling Web Services through Java

The core part of this snippet is the java task with the classname attribute set to org.apache.cxf.tools.wsdlto.WSDLToJava. Include this macro in your build file and then you can call it as shown in Listing 7.

Successfully running the tool will generate all necessary software artifacts, which include a service interface, a service endpoint interface (SEI), Java classes that implement all types defined in the WSDL document, and APIs that are used to obtain instances of these types.

Service Implementation Class
Now it's time to provide an implementation for the service. We do so by creating a Java class called MovieServiceImpl. There are some requirements that this class has to fulfill to become a service implementation class. It must be annotated with the JAX-WS @WebService annotation, and the endpointInterface member attribute of the annotation must refer to the generated SEI, i.e., org.example.movieservice.MovieService in our example. The service implementation bean may implement the SEI, but it's not required to do so. The service implementation bean must implement all method signatures defined in the SEI.

Listing 8 shows a code snippet of the implementation class.

Server Development and Service Publishing
We now need to create a server that hosts our service. XML-based Java Web Services can be hosted either in a managed or in non-managed environment.

Non-Managed Environment
JAX-WS provides functionality for creating and publishing Web Service endpoints dynamically using javax.xml.ws.Endpoint API running in a non-managed environment. CXF is JAX-WS-compliant and so supports JAX-WS dynamic Web Service publishing. Listing 9 is a code snippet of dynamic publishing.

This code is not CXF-specific and is portable among all JAX-WS-compliant runtimes. The complete server code is straightforward and sp omitted here. Start the server and you can then test the server by pointing your browser to the location: http://localhost:8080/MyMovieService?wsdl.

Managed Environment
Implementing Enterprise Web Services (JSR 109) defines ways of implementing Web Services and publishing endpoints in a managed environment. The use of dynamic publishing is considered non-portable in a managed environment. So JSR 109 requires that both the servlet and EJB container disallow publishing the endpoint dynamically by not granting the publishEndpoint security permission.

There are two means of implementing Web Services that run in a managed Java EE environment. The first is a container-based extension of the JAX-RPC or JAX-WS programming model, which defines a Web Service as a Java class running in Web container. The second one defines the use of a stateless enterprise session bean to run in the EJB container.

Due to the fact that CXF doesn't come with any Java EE container, neither is it specifically designed to support a particular vendor's Java EE container, it's quite different to implement Web Services in a managed environment using CXF. First, CXF doesn't support deploying Web Services in an EJB container. Second, the way of deploying Web Services in a web container is different from the one defined by JSR 109. While JSR 109 requires the container runtime to embed each endpoint implementation class in one servlet, CXF provides a generic servlet for all endpoint implementation classes.

Let's see this in action by deploying our example service to a Web container. The whole process involves 1.) configuring the Spring runtime to be aware of the service implementation class, 2.) registering the CXF servlet with the Web container and lastly, 3.) providing a configuration file that glues the last two together.

Configuring Spring is ;ole configuring a Spring project. A Spring context loader listener is added to the Web container via web.xml. Also added is the Spring configuration file, cxf-bean.xml, which is passed to the container as a context parameter. We'll cover this file momentarily. Listing 10 is a fragment of the web.xml file.

Registering CXF servlet is also straightforward. See Listing 11. Note that only one servlet is needed, and it acts as the entry point of all service endpoints.

We now need to somehow let the servlet know how to dispatch requests to the corresponding service implementation beans. This is the exact purpose of cxf-bean.xml, which is listed in Listing 12.

Using this file, we guide the servlet to forward all requests at the address /MovieService to MovieServiceImpl bean. Note that you'd better make sure that the value of the address attribute matches the one you advertised in the WSDL document.

After packaging the application and deploying it to a Web container (say, Tomcat), we can test the service by pointing the browser to the address http://localhost:8080/MovieService/cxf/MovieService?wsdl.

This concludes the server development. Now we move on to client development.

Client Development
In general, JAX-WS defines the Web Service client programming model, while JSR 109 defines the Web Service client programming model in a Java EE environment.

As mentioned, CXF doesn't have any Java EE runtime, so the primary way of creating a client is through JAX-WS. Listing 13 shows a simple client that consumes the MovieService Web Service.

RESTful Web Services Support
CXF supports RESTful Web Services by annotations. It uses four annotations for specifying the HTTP verb that will be used for a method:

  • org.codehaus.jra.Delete specifies that the method maps to a DELETE.
  • org.codehaus.jra.Get specifies that the method maps to a GET.
  • org.codehaus.jra.Post specifies that the method maps to a POST.
  • org.codehaus.jra.Put specifies that the method maps to a PUT.

Listing 14 is a code snippet that shows how annotations are used to implement RESTful services. Four services are defined that let clients book tickets, get ticket information, modify the booking, and cancel the booking, respectively. The code itself is fairly self-explanatory.

Assuming that these services are deployed and running, a client system can modify booking information by sending an HTTP request to an URL similar to the following, with the METHOD attribute of the request set to PUT. Note the bold portion of the URL:


More Stories By Jinsong Yang

Jinsong Yang is a senior application engineer at Warnerbros. Advanced Digital Services, and is a Sun Certified Enterprise Architect. He has devoted the last six-plus years to designing and integrating large-scale Java EE applications. He holds an MS in computer science from UCLA.

Comments (3)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

IoT & Smart Cities Stories
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
Nicolas Fierro is CEO of MIMIR Blockchain Solutions. He is a programmer, technologist, and operations dev who has worked with Ethereum and blockchain since 2014. His knowledge in blockchain dates to when he performed dev ops services to the Ethereum Foundation as one the privileged few developers to work with the original core team in Switzerland.
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...
Whenever a new technology hits the high points of hype, everyone starts talking about it like it will solve all their business problems. Blockchain is one of those technologies. According to Gartner's latest report on the hype cycle of emerging technologies, blockchain has just passed the peak of their hype cycle curve. If you read the news articles about it, one would think it has taken over the technology world. No disruptive technology is without its challenges and potential impediments t...
If a machine can invent, does this mean the end of the patent system as we know it? The patent system, both in the US and Europe, allows companies to protect their inventions and helps foster innovation. However, Artificial Intelligence (AI) could be set to disrupt the patent system as we know it. This talk will examine how AI may change the patent landscape in the years to come. Furthermore, ways in which companies can best protect their AI related inventions will be examined from both a US and...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks who attend the entire track can leave the conference with some of the skills necessary to get their work done when they get back to their offices. It actually ties back to some work that I'm doing at the University of San...