Index

A C F G L O R S 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addEvent(CFEvent) - Method in class coldfusion.eventgateway.GatewayServices
Add an event to the ColdFusion event service processing queue for delivery to a listener CFC.

C

CFEvent - Class in coldfusion.eventgateway
The message structure that is passed between gateways and ColdFusion CFML application code.
CFEvent(String) - Constructor for class coldfusion.eventgateway.CFEvent
 
coldfusion.eventgateway - package coldfusion.eventgateway
 

F

FAILED - Static variable in interface coldfusion.eventgateway.Gateway
Indicates that the gateway has failed.

G

Gateway - Interface in coldfusion.eventgateway
Gateway interface to the ColdFusion event gateway system.
GatewayHelper - Interface in coldfusion.eventgateway
Marker interface for gateway helper classes.
GatewayServices - Class in coldfusion.eventgateway
Functions for use by gateway implementers to interact with the ColdFusion event gateway service.
GenericGateway - Class in coldfusion.eventgateway
An abstract class that implements some of the ColdFusion event gateway protocol.
GenericGateway(String) - Constructor for class coldfusion.eventgateway.GenericGateway
Constructor.
getCfcMethod() - Method in class coldfusion.eventgateway.CFEvent
Get the name of the CFC method that processes the message.
getCfcPath() - Method in class coldfusion.eventgateway.CFEvent
Get the path to the listener CFC that processes this message.
getCfcTimeOut() - Method in class coldfusion.eventgateway.CFEvent
Get the time-out, in seconds, for the listener CFC to process the event request.
getData() - Method in class coldfusion.eventgateway.CFEvent
Get the message contents and other gateway-specific information.
getGatewayID() - Method in class coldfusion.eventgateway.CFEvent
Identify the event gateway instance, as specified in the ColdFusion MX Administrator.
getGatewayID() - Method in interface coldfusion.eventgateway.Gateway
Return the ID that uniquely defines the gateway instance.
getGatewayID() - Method in class coldfusion.eventgateway.GenericGateway
Return the ID that uniquely defines the gateway instance.
getGatewayServices() - Static method in class coldfusion.eventgateway.GatewayServices
Return A GatewayServices object.
getGatewayServices() - Method in class coldfusion.eventgateway.GenericGateway
Provide access to the ColdFusion GatewayServices object.
getGatewayType() - Method in class coldfusion.eventgateway.CFEvent
Identify the gateway type of the gateway this message originated from.
getHelper() - Method in interface coldfusion.eventgateway.Gateway
Return a gateway helper class (if any) so that a CFC can invoke gateway-specific utility functions that might be useful to the CFML developer.
getHelper() - Method in class coldfusion.eventgateway.GenericGateway
Override this function if you want to provide a helper class for your gateway.
getListeners() - Method in class coldfusion.eventgateway.GenericGateway
Return the listeners for this gateway.
getLogger() - Method in class coldfusion.eventgateway.GatewayServices
Get the default event logging object.
getLogger(String) - Method in class coldfusion.eventgateway.GatewayServices
Get a custom event logging object.
getMaxQueueSize() - Method in class coldfusion.eventgateway.GatewayServices
Return the maximum size of the gateway event queue.
getOriginatorID() - Method in class coldfusion.eventgateway.CFEvent
Identify the originator of an incoming message.
getQueueSize() - Method in class coldfusion.eventgateway.GatewayServices
Return the current size of the gateway event queue.
getStatus() - Method in interface coldfusion.eventgateway.Gateway
Return the status of the gateway.
getStatus() - Method in class coldfusion.eventgateway.GenericGateway
Return the status of the gateway.

L

listeners - Variable in class coldfusion.eventgateway.GenericGateway
 

O

outgoingMessage(CFEvent) - Method in interface coldfusion.eventgateway.Gateway
Send a message from the gateway to the resource.

R

restart() - Method in interface coldfusion.eventgateway.Gateway
Restart this gateway.
restart() - Method in class coldfusion.eventgateway.GenericGateway
Restart this gateway.
RUNNING - Static variable in interface coldfusion.eventgateway.Gateway
Indicates that the gateway is running.

S

sendMessage(CFEvent) - Method in class coldfusion.eventgateway.GenericGateway
Send an event to the ColdFusion event gateway service.
setCFCListeners(String[]) - Method in interface coldfusion.eventgateway.Gateway
Set the CFClisteners list.
setCFCListeners(String[]) - Method in class coldfusion.eventgateway.GenericGateway
Set the CFClisteners list.
setCfcMethod(String) - Method in class coldfusion.eventgateway.CFEvent
Set the name of the CFC method that should processes an incoming message.
setCfcPath(String) - Method in class coldfusion.eventgateway.CFEvent
Specify the listener CFC that will process this event.
setCfcTimeOut(int) - Method in class coldfusion.eventgateway.CFEvent
Set the time-out, in seconds, during which the listener CFC must process the event request before ColdFusion gateway services terminates the request and logs an error in the application.log file.
setData(Map) - Method in class coldfusion.eventgateway.CFEvent
Add the gateway-specific data, including any message contents, as a Java Map to the CFEvent object.
setGatewayID(String) - Method in interface coldfusion.eventgateway.Gateway
Set the ID that uniquely defines the gateway instance.
setGatewayID(String) - Method in class coldfusion.eventgateway.GenericGateway
Set the ID that uniquely defines the gateway instance.
setGatewayType(String) - Method in class coldfusion.eventgateway.CFEvent
Set the type of event gateway, such as IM, SMS, or EMail.
setOriginatorID(String) - Method in class coldfusion.eventgateway.CFEvent
Set the originator of an incoming message.
start() - Method in interface coldfusion.eventgateway.Gateway
Start this gateway.
start() - Method in class coldfusion.eventgateway.GenericGateway
Start the gateway.
startGateway() - Method in class coldfusion.eventgateway.GenericGateway
Gateway startup method.
STARTING - Static variable in interface coldfusion.eventgateway.Gateway
Indicates that the gateway is starting.
status - Variable in class coldfusion.eventgateway.GenericGateway
 
stop() - Method in interface coldfusion.eventgateway.Gateway
Stop this gateway.
stop() - Method in class coldfusion.eventgateway.GenericGateway
Stop the gateway.
stopGateway() - Method in class coldfusion.eventgateway.GenericGateway
Gateway shutdown method.
STOPPED - Static variable in interface coldfusion.eventgateway.Gateway
Indicates that the gateway has stopped.
STOPPING - Static variable in interface coldfusion.eventgateway.Gateway
Indicates that the gateway is stopping.
A C F G L O R S 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form