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

ColdFusion: Article

Using Gateways PART 2

The basics

Part 1 in this series (CFDJ, Vol. 7, issue 5) discussed the options in the ColdFusion Administrator for configuring the event gateway facility in ColdFusion MX 7 and how to register new event gateway types.

There was little in the way of explaining how to use event gateways, so in this article we'll explore the basics of using event gateways through two examples: the code from the previous article and another of the out-of-the-box event gateway types, the CFML asynchronous event gateway type. These two gateway types represent the two fundamental varieties: the types that respond to events external to a ColdFusion application and the types that respond to events generated within a ColdFusion application.

Event gateways represent a new kind of service architecture for ColdFusion that is composed of a number of logical groups, each with its own intricacies. This article glosses over much of the deeper details with the intent of getting you up and running without bogging you down. Not to worry though, the finer details ignored now will be covered in greater detail in a later article.

A rough overview of the choreography of gateways can be seen in the ColdFusion MX 7 product documentation (Developing ColdFusion MX Applications, Using Event Gateways, About event gateways, How event gateway applications work). Many of the framed pieces in this diagram are identified with common event gateway jargon discussed in Part 1. [http://livedocs.macromedia.com/coldfusion/7/ htmldocs/images/gatewayb.jpg]

The two discrete pieces we're going to discuss in this article are the listener CFCs and CFM Pages (the calling logic being either a CFML template or a ColdFusion Component).

CFML Code for Gateways
To create a gateway instance you need a gateway type, a configuration file (which is optional in some cases) and a listener CFC. ColdFusion MX 7 comes with seven gateway types to start you off, one of which, the DirectoryWatcher type, was used in the previous article to verify the instructions for creating a gateway instance. Since the sample code was for an event gateway that responded to external OS level events, it had only a listener CFC written for it, which is a good place to begin.

Listener CFCs
Developers familiar with frameworks in other languages will recognize the role that the methods in a listener CFC fulfill - the event handler. Similar to a class implementing a component or control delegate in the .NET Framework or a Java bean event listener in Java, the listener CFC is the chunk of code that is the implementation-specific part of the more generic problem domain as defined by the gateway type.

While the gateway type defines the method names, the signature always remains the same (with the obvious exception of the method name itself): a public method with one argument, a structure, which may return a string. (Note: Signature is a term used to indicate a function's or a method's definition, its name, the names and data types of its arguments, and data type of the returned value [http://en.wikipedia.org/wiki/Signature_%28Computer_Science%29].)

Event Handling Methods
The one method argument is called the CFEvent and contains information about the gateway instance, the default listener CFC that the gateway instance will use, and a structure containing any data elements sent by the method's calling logic. These data elements can be populated by the Java code of the gateway type as well as the CFML code invoking the gateway instance.

The Members of CFEvent
Each event handler method receives a single structure, the CFEvent argument. This structure contains seven members by default that are almost solely for informational purposes. They are listed in Table 1 and in the ColdFusion product documentation (CFML Reference, ColdFusion MX Event Gateway Reference, CFML CFEvent structure).

Reviewing the Previous Sample
Looking at the code from Part 1 (available at: [http://gemsres.com/story/may05/86134/source.html]), we find two files, CCOJASDirectoryWatcher.cfg (the configuration file) and CCOJASDirectoryWatcher.cfc (the listener CFC), which were used to create the gateway instance, CCOJASDirectoryWatcher.

Within this component we see three methods: onAdd, onDelete, and onChange. These methods are defined by the DirectoryWatcher gateway type (Developing ColdFusion MX Applications, Using Event Gateways, Using the example event gateways and gateway applications). These methods are the event handlers for the DirectoryWatcher gateway instance and none of them are required. If a listener CFC does not implement one of these event handling methods, the gateway instance does not attempt to make a call to the method. This means that the listener CFC needs to implement only what is germane to the problem domain and nothing more.

The CFEvent's data Member
In the case of this example, all three event handling methods were implemented and, as was demonstrated in Part 1 ("Cold Cup o' Joe - Another Shot: Gateways to Fun, Putting It All Together"), a log file was updated each time a file was added to, changed, and deleted from the watched directory. What is more interesting now is not just the execution of the gateway instance but the variables that get passed to the event handling methods.

Referring to CCOJASDirectoryWatcher.cfc from Part 1, you'll see that the first functional line of each method (lines 5, 12, and 19) pull out a structure called data from each method's CFEvent argument. This contains data about each OS level event that the DirectoryWatcher was monitoring for. This structure contains three members, identified in the ColdFusion product documentation (Developing ColdFusion MX Applications, Using Event Gateways, Using the example event gateways and gateway applications, Example event gateway, CFC methods) and shown in Table 2.

More Stories By Guy Rish

Guy Rish is a ColdFusion and .NET developer at Vente as well as President at Gestaltech. He is an active developer and writer for various languages and technologies, and has contributed work in books on ColdFusion MX, Flash MX, and Dreamweaver MX. He blogs at ccoj.coldfusionjournal.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.

@ThingsExpo Stories
With 10 simultaneous tracks, keynotes, general sessions and targeted breakout classes, @CloudEXPO and DXWorldEXPO are two of the most important technology events of the year. Since its launch over eight years ago, @CloudEXPO and DXWorldEXPO have presented a rock star faculty as well as showcased hundreds of sponsors and exhibitors! In this blog post, we provide 7 tips on how, as part of our world-class faculty, you can deliver one of the most popular sessions at our events. But before reading...
DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
DXWorldEXPO LLC announced today that ICOHOLDER named "Media Sponsor" of Miami Blockchain Event by FinTechEXPO. ICOHOLDER give you detailed information and help the community to invest in the trusty projects. Miami Blockchain Event by FinTechEXPO has opened its Call for Papers. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Miami Blockchain Event by FinTechEXPO also offers s...
DXWorldEXPO | CloudEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
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 and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
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...
Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities - ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups.
Poor data quality and analytics drive down business value. In fact, Gartner estimated that the average financial impact of poor data quality on organizations is $9.7 million per year. But bad data is much more than a cost center. By eroding trust in information, analytics and the business decisions based on these, it is a serious impediment to digital transformation.
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...
Predicting the future has never been more challenging - not because of the lack of data but because of the flood of ungoverned and risk laden information. Microsoft states that 2.5 exabytes of data are created every day. Expectations and reliance on data are being pushed to the limits, as demands around hybrid options continue to grow.
Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
As IoT continues to increase momentum, so does the associated risk. Secure Device Lifecycle Management (DLM) is ranked as one of the most important technology areas of IoT. Driving this trend is the realization that secure support for IoT devices provides companies the ability to deliver high-quality, reliable, secure offerings faster, create new revenue streams, and reduce support costs, all while building a competitive advantage in their markets. In this session, we will use customer use cases...
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...
The best way to leverage your Cloud Expo presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering Cloud Expo and @ThingsExpo will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at Cloud Expo. Product announcements during our show provide your company with the most reach through our targeted audiences.
DevOpsSummit New York 2018, colocated with CloudEXPO | DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City. Digital Transformation (DX) is a major focus with the introduction of DXWorldEXPO within the program. 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 bus...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...
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...
DXWorldEXPO LLC announced today that "Miami Blockchain Event by FinTechEXPO" has announced that its Call for Papers is now open. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Financial enterprises in New York City, London, Singapore, and other world financial capitals are embracing a new generation of smart, automated FinTech that eliminates many cumbersome, slow, and expe...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. 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 ov...