Table of Contents
Advertisement
DEVELOPING COLDFUSION 9 APPLICATIONS
Using External Resources
IMGatewayHelper methods
The ColdFusion IM gateway provides the IMGatewayHelper class, a gateway helper that you can access by calling the
CFML
function. The IMGatewayHelper class has methods that let you do the following:
GetGatewayHelper
• Get and set gateway configuration information and get gateway statistics
• Get and set the gateway online presence status
• Manage the gateway's buddy list
• Manage permissions for others to get information about the gateway status.
For more information on using GatewayHelper methods, including lists of all the methods, see
GatewayHelper
object" on page 1287.
Configuring an IM event gateway
You provide IM-specific configuration information to the IM event gateway in a configuration file. You specify the
configuration file location when you configure the IM event gateway instance in the ColdFusion Administrator.
ColdFusion provides sample XMPP and Lotus Sametime event gateway configuration files in the cf_root\WEB-
INF\cfusion\gateway\config directory on J2EE configurations, and cf_root\gateway\config directory on server
configurations. The configuration file can have the following information.
Note: The default value in the table is the value the gateway uses if the configuration file omits the property, not the value
in the default configuration files.
Property
Default value
userID
none
password
none
secureprotocol
none
securerequirement
false
serverip
XMPP: jabber.org
Sametime:
stdemo3.dfw.ibm.com
serverport
XMPP: 5222
Sametime:1533
Description
(Required) The IM user ID to use to connect to the IM server.
(Required) Password for the user.
XMPP only.
Required if you set
securerequirement
The protocol to use for secure communications. The following values are valid:
•
TSL
•
SSL
XMPP only.
Specifies whether the gateway must use secure communications. The following values
are valid:
•
true
•
false
If this value is true, specify a
secureprotocol
a secure connection is established.
Address of XMPP or Lotus Sametime server to which to send messages. Can be a server
name or IP address.
Port on the server to which to send the messages.
parameter is set to SSL, specify 5223.
If the XMPP
secureprotocol
Last updated 8/5/2010
"Using the
to true.
value, and connections succeed only if
1279
Advertisement
Table of Contents
