setGatewayType

Description

Identifies the type of event gateway.

Category

Event Gateway Development

Syntax

void setGatewayType(String gatewayType)

See also

Parameters

getGatewayType, CFML CFEvent structure, CFEvent class in Creating Custom Event Gateways in ColdFusion MX Developer's Guide

Usage

For the sake of consistency, use the same name in this method and in the Type Name field when you add the event gateway type in the ColdFusion MX Administrator. Gateway application CFCs that handle multiple gateway types, such as those in an instant messaging application that handles multiple instant messaging providers, could use this field to determine the protocol type and any gateway type-specific actions.

Example

The following code shows the routine from the example JMS gateway that handles incoming messages. It sets the gateway type to JMS:

public void handleMessage(String msg, String topicName, String msgID) {
   coldfusion.eventgateway.Logger log = getGatewayServices().getLogger();
   Map data = new HashMap();
   CFEvent cfMsg = new CFEvent(getGatewayID());
   data.put("msg", msg);
   data.put("id", msgID);
   cfMsg.setData(data);
   cfMsg.setOriginatorID(topicName);
   cfMsg.setGatewayType("JMS");
   if (sendMessage(cfMsg)) {
         log.info("Added message '" + msgID + "' to queue.");
   } else {
         log.error("Failed to add message '" + msgID + "' to queue.");
   }
}

View comments in LiveDocs