public class CFEvent
extends coldfusion.util.FastHashtable
gatewayType: The type of gateway. Usually corresponds to the message
type (SMS/IM/EMAIL/DB etc).
cfcPath: Overrides the default cfcPath specified in the ColdFusion MX
Administrator.
originatorID: Where the message came from.
gatewayID: The event gateway that handled the event or will handle the
outgoing message.
cfcMethod: The method in the CFC to call.
data: The message to pass to the CFC. It is in hashtable format for
flexibility.
cfcTimeOut: The time-out for the request. If set, the thread will use
it to set the time-out of the request; if not, the thread will use the
default request timeout.
Constructor and Description |
---|
CFEvent(java.lang.String gwID) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCfcMethod()
Get the name of the CFC method that processes the message.
|
java.lang.String |
getCfcPath()
Get the path to the listener CFC that processes this message.
|
java.lang.Integer |
getCfcTimeOut()
Get the time-out, in seconds, for the listener CFC to process the event
request.
|
java.util.Map |
getData()
Get the message contents and other gateway-specific information.
|
java.lang.String |
getGatewayID()
Identify the event gateway instance, as specified in the ColdFusion MX
Administrator.
|
java.lang.String |
getGatewayType()
Identify the gateway type of the gateway this message originated from.
|
java.lang.String |
getOriginatorID()
Identify the originator of an incoming message.
|
void |
setCfcMethod(java.lang.String e)
Set the name of the CFC method that should processes an incoming message.
|
void |
setCfcPath(java.lang.String c)
Specify the listener CFC that will process this event.
|
void |
setCfcTimeOut(int d)
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.
|
void |
setData(java.util.Map m)
Add the gateway-specific data, including any message contents, as a
Java Map to the CFEvent object.
|
void |
setGatewayType(java.lang.String type)
Set the type of event gateway, such as IM, SMS, or EMail.
|
void |
setOriginatorID(java.lang.String id)
Set the originator of an incoming message.
|
clear, contains, containsKey, duplicate, elements, get, isEmpty, keys, put, putAll, remove, size
_containsKey, caseHandledEntrySet, caseHandledKeySet, clone, containsValue, duplicate, entrySet, equals, get, hashCode, isCaseSensitive, keySet, put, remove, toString, values
public CFEvent(java.lang.String gwID)
gwID
- The ID of the gateway.
This parameter indicates the source of the message and must be the value
that is passed in the Gateway constructor or set using the Gateway
setGatewayID method.public void setGatewayType(java.lang.String type)
type
- The gateway type identifier. This ID is created by the
Gateway class author and should reflect the type of gateway. It does not
have to be gateway type name used in the ColdFusion Administrator.public void setOriginatorID(java.lang.String id)
id
- The gateway or protocol-specific ID of the message originator.public void setCfcMethod(java.lang.String e)
e
- The method in the listener CFC that ColdFusion will call to
process this event. If you do not use this method in your gateway,
ColdFusion invokes the onIncomingMessage method,public void setData(java.util.Map m)
m
- The incoming message and any additional gateway-specific event data.public void setCfcPath(java.lang.String c)
c
- An absolute path to the application listener CFC that will
process the event.public void setCfcTimeOut(int d)
d
- Timeout period, in seconds.public java.lang.String getGatewayType()
public java.lang.String getOriginatorID()
public java.lang.String getGatewayID()
public java.lang.String getCfcMethod()
public java.util.Map getData()
public java.lang.String getCfcPath()
public java.lang.Integer getCfcTimeOut()