Sun Java System Instant Messaging 7.2 Administration Guide

Appendix B Instant Messaging XMPP/HTTP Gateway Configuration Parameters in httpbind.conf

Instant Messaging stores configuration settings for the XMPP/HTTP Gateway in the httpbind.conf file. This appendix describes the configuration parameters and the file in the following sections:

Any time you modify the httpbind.conf file, you need to restart the XMPP/HTTP Gateway using the tools provided by your web container or application server.

httpbind.conf File Location

By default, the configure utility creates the httpbind.conf file within the Configuration Directory (im-cfg-base) of the default server instance, for example:

If you created multiple instances of Instant Messaging, the name of the /default directory will vary depending on the instance. See Creating Multiple Instances from a Single Instant Messaging Installation for more information. This file is created by the configure utility only in the default instance's im-cfg-base directory.

httpbind.conf File Syntax

The httpbind.conf file is a plain ASCII text file, with each line defining a gateway parameter and its value(s):

Note –

The httpbind.conf file is initialized by the configure utility and should be modified only as described in this guide.

Instant Messaging XMPP/HTTP Gateway Configuration Parameters

Table B–1 describes the configuration parameters in httpbind.conf.

Table B–1 XMPP/HTTP Gateway Configuration Parameters in httpbind.conf


Default Value 




If is set to true, this parameter specifies the full URL for the server node in the server pool. This URL should not point to a load balancer, but to an Instant Messaging server instance.


This parameter defines whether or not the gateway is in a server pool deployment. If no httpbind.pool.nodeId is specified, the value for this parameter is set to false.

The value for this parameter can be: 

  • true – the gateway is part of a server pool deployment. In addition, enable, on, yes, and 1 are also valid values. If you set this parameter to true, you must provide a value for httpbind.pool.nodeId.

  • false – (default) the gateway is not part of a server pool deployment. Leaving the value blank (empty string) is also a valid value.



Contains a comma-separated list of ID keys, or gwdomain-id, which the gateway uses as a configuration key to determine which domains, hosts, host passwords, and component JIDs the gateway should use. See Table B–2 for more information on ID keys.


text/xml; charset=utf-8

The default value for the content-type HTTP header the gateway uses when sending a response back to the client.



Specifies the maximum permissible value for the hold attribute in the client request as defined in JEP 124. If the client specifies a value higher than the gateway in the request, the gateway's value will be used. Otherwise, the value in the client request will be used.



The maximum time in seconds of client inactivity after which the gateway will terminate the connection to the client. 



The location of the log4j configuration file the gateway will use for logging. If you leave this parameter blank, then logging for the gateway is turned off. The logger name is “httpbind” (log4j.logger.httpbind).


1 (second)

The minimum time, in seconds, a client must wait before sending another request. 



The number of concurrent requests a client can make to the gateway. If the value of this parameter is less than the value for the JEP 124 hold attribute in the client request, the value for this parameter will be set to hold+1. Do not set this parameter to 1, as doing so could severely degrade performance. See httpbind.hold for more information.


1 (second)

The amount of time, in seconds, to allow in addition to time-outs for round trips to account for network latencies. Setting this value too high may degrade performance. 


120 (seconds)

The default time, in seconds, within which the gateway will send a response to the client. If the client wait time is set to a value higher than the gateway wait time, the gateway's wait time is used. 

Gateway Domain ID Key Parameters for httpbind.config

Table B–2 describes the keys used to define each ID in the httpbind.config parameter. In each key described in the table, gwdomain-id is a domain identifier specified in httpbind.config.

Table B–2 httpbind.config ID Keys



Comma-separated list of domains for this ID. 


Space-separated list of hosts for this ID. Each of these hosts must be able to service the domains listed in This list helps provide failover across the domains. If no explicit route host mentioned in the request, one of the hosts listed in this key will be used to service that request.


The component JID to use to connect to the host.  


The password to use to connect to the host.