Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion, Machine Learning

ColdFusion: Article

Creating a ColdFusion Web Service

This is the ColdFusion equivalent of the PHP Web service we just looked at

This content is reprinted from Real-World AJAX: Secrets of the Masters published by SYS-CON Books. To order the entire book now along with companion DVDs for the special pre-order price, click here for more information. Aimed at everyone from enterprise developers to self-taught scripters, Real-World AJAX: Secrets of the Masters is the perfect book for anyone who wants to start developing AJAX applications.

Creating a ColdFusion Web Service
We'll duplicate our PHP Web service in ColdFusion now using XMLRPC.CFC to format our XML response and the CFJSON.cfm for our JSON response.

Listing 6.7 The Code

<CFSETTING showDebugOutput="no" enablecfoutputonly="yes">
<!--- Because of ColdFusion's poor whitespace handling it is necessary to
//--- use enablecfoutputonly="yes" and then wrap all of our output in CFOUTPUT tags.
--->

<!--- Only proceed if we were given numbers to sum --->
<CFIF IsDefined('URL.numbers')>
   <!--- Split our string into an array using REReplace on any non-digit character. --->
   <CFSET numbers = ListToArray(REReplace(URL.numbers, "[^\d]+", " ", "all"), ' ')>
   <CFSET sum = ArraySum(numbers)>

   <!--- Build our response object.
   //--- We include the original request only to make our response more complex.
   --->
   <CFSET response = StructNew()>
   <CFSET garbage = StructInsert(response, 'sum', sum)>
   <CFSET garbage = StructInsert(response, 'numbers', numbers)>

   <!--- Check to see if an output format was requested, and if it was JSON
   //--- Return XML output by default
   --->
   <CFIF IsDefined('URL.output') AND URL.output EQ 'json'>
     <CFINCLUDE template="jsencode.cfm">
     <CFOUTPUT>#jsonencode(response)#</CFOUTPUT>
   <CFELSE>
     <!--- Send our XML content-type header --->
     <CFHEADER name="Content-type" value="text/xml">
     <CFSET arr = ArrayNew(1)>
     <CFSET arr[1] = #response#>
       <!--- We're using the XMLRPC component to format our response --->
     <CFINVOKE component="xmlrpc"
       method="CFML2XMLRPC"
       returnvariable="rs"
       type="response"
       data="#arr#">

       <!--- Replace is only used to make our output more human-readable --->
       <CFOUTPUT><?xml version="1.0" encoding="iso-8859-1"?>
         #Replace(rs, "><", ">" & Chr(13) & Chr(10) & "<", "all")#
       </CFOUTPUT>
     </CFIF>
   </CFIF>

Dissecting the Code
This is the ColdFusion equivalent of the PHP Web service we just looked at. It can be accessed in a REST-like manner through the resources URI and expects two variables in the query string: numbers and output. The variable numbers will contain a delimited list of numbers that this Web service will sum and return. To make our return object more complex, we'll return the original request as well as the sum. You can specify your desired output format by setting output to JSON or XML.

A normal GET request to http://yourserver/add.cfm?numbers=1+2+3&output=json will print the following:

{"numbers":[1,2,3],"sum":6}

That same request with output set to XML (http://yourserver/add.cfm?numbers=1+2+3&output=xml) will return:

Listing 6.8

<?xml version="1.0" encoding="iso-8859-1"?>
<methodResponse>
  <params>
   <param>
    <value>
     <struct>
      <member>
       <name>numbers</name>
       <value>
        <array>
         <data>
          <value>
           <double>1</double>
          </value>
          <value>
           <double>2</double>
          </value>
          <value>
           <double>3</double>
          </value>
         </data>
        </array>
       </value>
      </member>
      <member>
       <name>sum</name>
        <value>
         <double>6</double>
        </value>
       </member>
      </struct>
     </value>
    </param>
   </params>
</methodResponse>

There are slight differences between the PHP and ColdFusion XML output, with the ColdFusion XML-RPC component choosing to define anything that passes isNumeric() as a double. You can force a type, but to keep the code simple we haven't done that here. We array_walk() to apply settype() to all the values of our array in PHP and set the type to integer.

Now that we've created some Web services, let's take a look at how to use AJAX to consume these and other Web services.

Server-Side Architectures
In this section we'll build several AJAX applications that will consume a Web service. We'll show examples that use a client-side framework and server-side frameworks.

This content is reprinted from Real-World AJAX: Secrets of the Masters published by SYS-CON Books. To order the entire book now along with companion DVDs, click here to order.

More Stories By Corey Gilmore

Corey Gilmore is the president of CFG Consulting, Inc., specializing in developing rich internet applications with ColdFusion, PHP and Ajax for the Federal government and Fortune 100 clients. He guiltily enjoys designing and implementing low-cost, high performance business continuity plans using VMware ESX server. As the former Director of Information Technology for the United States Senate Democratic Leadership, he designed and implemented a continuity of operations plan to ensure Senate business continuity in the event of a disaster. Corey can be reached at cfgci.com.

More Stories By Jason Blum

Jason Blum is principal engineer with the advanced technologies development team in the United States Senate, Office of the Sergeant at Arms. Formerly the lead administrator of the Senate’s shared Web hosting environment, Jason now designs and manages the implementation of schema and pattern-centric solutions for Senate offices in XML, ColdFusion, Flex, and .NET. He is a Certified Advanced ColdFusion developer with a BA in philosophy, Masters Degrees in philosophy of education and in IT, and an intermediate certification in Hungarian from itk.hu.

More Stories By Phil McCarthy

Philip McCarthy is a UK-based software development consultant
specializing in J2EE and Web technologies. An early adopter of rich
browser-based client development, he has several years' experience of integrating Ajax technologies into enterprise Java frameworks, gained on projects in the financial services, telecoms, and digital media sectors. Philip is also the author of the "Ajax for Java Developers" series for IBM developerWorks, and blogs about software development at chimpen.com.

Comments (0)

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
Every organization is facing their own Digital Transformation as they attempt to stay ahead of the competition, or worse, just keep up. Each new opportunity, whether embracing machine learning, IoT, or a cloud migration, seems to bring new development, deployment, and management models. The results are more diverse and federated computing models than any time in our history.
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
IoT is rapidly becoming mainstream as more and more investments are made into the platforms and technology. As this movement continues to expand and gain momentum it creates a massive wall of noise that can be difficult to sift through. Unfortunately, this inevitably makes IoT less approachable for people to get started with and can hamper efforts to integrate this key technology into your own portfolio. There are so many connected products already in place today with many hundreds more on the h...
The standardization of container runtimes and images has sparked the creation of an almost overwhelming number of new open source projects that build on and otherwise work with these specifications. Of course, there's Kubernetes, which orchestrates and manages collections of containers. It was one of the first and best-known examples of projects that make containers truly useful for production use. However, more recently, the container ecosystem has truly exploded. A service mesh like Istio addr...
Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
Charles Araujo is an industry analyst, internationally recognized authority on the Digital Enterprise and author of The Quantum Age of IT: Why Everything You Know About IT is About to Change. As Principal Analyst with Intellyx, he writes, speaks and advises organizations on how to navigate through this time of disruption. He is also the founder of The Institute for Digital Transformation and a sought after keynote speaker. He has been a regular contributor to both InformationWeek and CIO Insight...
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...