User Guide

Table Of Contents
1022 Chapter 42: Using Event Gateways
Event gateway instance A specific instance of an event gateway type class. You configure each
event gateway instance on the ColdFusion MX Gateways page by specifying the event gateway
type, an ID, the path to the event gateway application CFC that uses this instance, and a
configuration file (if needed for the selected event gateway type). You can have multiple event
gateway instances per event gateway type, for example, for different event gateway applications.
Event gateway application One or more CFCs and any supporting CFM pages that handle
events from an event gateway instance and send messages using the event gateway instance. The
event gateway application is not part of an event gateway instance, but the code that is responsible
for processing event messages to and from the instance.
Event gateway listener Code in an event gateway that receives events from an event source and
passes them to the ColdFusion MX gateway service for delivery to a CFML listener CFC.
Listener CFC A CFC that contains one or more methods that respond to incoming messages
from one or more event gateway instances. Part of an event gateway application.
ColdFusion MX gateway service The part of ColdFusion that provides underlying support for
event gateways, including a path between an event gateway instance and listener CFCs.
How event gateway applications work
The following diagram shows the architecture of ColdFusion event gateway applications:
How event gateways interact
Typically, a ColdFusion event gateway instance, a Java object, listens for events coming from an
external provider. For example, a general socket event gateway listens for messages on an IP
socket, and an SMS event gateway receives messages from an SMSC server.
Each event gateway instance communicates with one or more listener CFCs through the
ColdFusion event gateway service. The listener CFCs receive CFEvent object instances that
contain the messages, process them, and can send responses back to the event gateway, which can
send the messages to the external resources.
Event Gateway
Instance
SMSC server
(for SMS messages)
Instant
messaging
provider
Other message
generator/receiver
Event Gateway
Instance
Event Gateway
Instance
ColdFusion
Event
Gateway
Service
Java
Event
Event
Event
Event
Event
Event
CFEvent
CFEvent
CFEvent
CFEvent
CFEvent
CFEvent
ColdFusion
Event Gateway
Application
Event Gateway
Application
CFML
Listener CFC
CFEvent
Message
Event Gateway
Application
Listener CFC
CFEvent
Message
CFEvent
Message
Listener CFC
CFM Page
.
.
.
.
.
.
.
.
.