Configuring the Instant Messaging XMPP/HTTP Gateway

When you run the configure utility after installation,
you can choose to deploy the XMPP/HTTP Gateway or not. If enabled, the configure utility creates a default configuration file (httpbind.conf)
for the gateway. You can change the configuration by modifying the values
in this file. See Appendix B, Instant Messaging XMPP/HTTP Gateway Configuration Parameters in httpbind.conf for a
description of httpbind.conf file syntax, file location,
and a list of configuration parameters in this file, or refer to the instructions
in this section.

In addition, when you choose to deploy the gateway during initial configuration,
the configure utility creates a .war file in the im-svr-base/work directory and then deploys this file on the web or application
server in the directory you specified for the codebase.

You can also configure the gateway to use a non-default configuration
file by modifying the values in web.xml which is deployed
with the client resources on the web container.

The instructions in this section assume the gateway configuration file
is httpbind.conf. If you are using a non-default configuration
file, substitute your configuration file for httpbind.conf in
the instructions.

Any time you make a change to httpbind.conf, you will need to restart
the XMPP/HTTP Gateway.

Set the httpbind.requests parameter to
the maximum number of concurrent requests a single client can send to the
gateway.

The default is 2. For example:

httpbind.requests=2

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 To Set the JEP 124 hold Attribute for Client Requests to the XMPP/HTTP Gateway and Table B–1 for more information on the httpbind.hold parameter.

Save and close httpbind.conf.

Restart the gateway using the tools provided by the web or application
server.

To Set the JEP 124 hold Attribute
for Client Requests to the XMPP/HTTP Gateway

To Set the Default Time Within Which the XMPP/HTTP Gateway Will
Send a Response to the Client

The client is guaranteed a response from the XMPP/HTTP Gateway within the
wait time you designate with this parameter. Consider the speed of your network
when setting this parameter. Do not set the value so low that the XMPP/HTTP Gateway is
unlikely to be able to send the request in time.

The value is
in seconds. The default is 120 seconds. For example:

httpbind.wait_time=120

If the value set for the client is greater than the value for the gateway,
the gateway wait time is used.

Save and close httpbind.conf.

Restart the gateway using the tools provided by the web or application
server.

To Configure an XMPP/HTTP Gateway in a Instant Messaging Gateway
Pool

To configure the gateway as part of a deployment with an Instant Messaging gateway
pool:

Set the httpbind.pool.support parameter
to true:

httpbind.pool.support=true

Set the httpbind.pool.nodeId parameter
to the full URL of the gateway.

The URL is used as the gateway's
nodeId. This nodeId must be unique within the server pool. The gateway uses
this nodeId to determine whether it must service a received request or forward
the request to another gateway in the pool.

To configure the gateway not to work within a gateway pool, set
the httpbind.pool.support parameter as follows:

httpbind.pool.support=false

Save and close httpbind.conf.

Restart the gateway using the tools provided by the web or application
server.

To Configure the List of Key IDs for Supported XMPP/HTTP Gateway Domains

Restart the gateway using the tools provided by the web or application
server.

To Configure the Instant Messaging XMPP/HTTP Gateway to Use
a Non-default Configuration File

On the web container on which Instant Messenger resource files
are deployed, edit web.xml.

Use your web
container's tools to edit this file.

Change the value for the httpbind.config.file parameter
to the location of the configuration file you want the gateway to use.

Securing Communication Between the XMPP/HTTP Gateway and Instant Messaging Server
Using StartTLS

The XMPP/HTTP Gateway only
supports StartTLS for secure communications. If the multiplexor is configured
to use legacy SSL, you need to configure the gateway to
connect directly to the server, bypassing the multiplexor. The gateway will
always attempt to use StartTLS if it is available. See Chapter 12, Securing Instant Messaging Using TLS and Legacy SSL for more information.

Managing Logging for the XMPP/HTTP Gateway

You can configure the level of logging for the XMPP/HTTP Gateway, enable
or disable logging entirely, and change the location of the gateway log file
or the gateway log configuration file as described in the following sections:

Under most circumstances, you should modify the configuration in the httpbind_log4j.conf file itself, leaving the httpbind.log4j.config parameter set to the location of the httpbind_log4j.conf file.
This procedure describes modifying the configuration within the httpbind_log4j.conf file.

Open the httpbind_log4j.conf file.

This
file is stored at the location you specified in httpbind.conf file
as the value for the httpbind.log4j.config parameter.
By default the file is stored in the following directory under the default Instant Messaging instance:

im-cfg-base/httpbind_log4j.conf

To disable logging for the gateway, set the log4j.logger.gateway parameter as follows:

log4j.logger.gateway=OFF

To enable logging, set the log4j.logger.gateway parameter
to the desired logging level.

To Change the Location of the XMPP/HTTP Gateway Log Configuration
File

Set the value of the httpbind.log4j.config parameter
to the location of the XMPP/HTTP Gateway log configuration file.

Save and close httpbind.conf.

Restart the gateway using the tools provided by the web or application
server.

Linux: To Set the Location of the XMPP/HTTP Gateway Log
File After Install or Upgrade

On Linux, after you install and configure the XMPP/HTTP Gateway,
you need to modify the location of the default log file for the XMPP/HTTP
gateway in httpbind_log4j.conf.

Open the httpbind_log4j.conf file.

This
file is stored at the location you specified in httpbind.conf file
as the value for the httpbind.log4j.config parameter.
By default the file is stored in the following directory under the default Instant Messaging instance:

im-cfg-base/httpbind_log4j.conf

Set the value of the log4.appender.appender_ID.file parameter
to the location where log files are stored.

To Change the Location of the XMPP/HTTP Gateway Log File

Before You Begin

This
file is stored at the location you specified in httpbind.conf file
as the value for the httpbind.log4j.config parameter.
By default the file is stored in the following directory under the default Instant Messaging instance:

im-cfg-base/httpbind_log4j.conf

Set the value for the log4j.appender.appender-ID parameter to the location where you want to store
the log file.

Save and close httpbind_log4j.conf.

Restart the web container.

To Use a Non-default Log File Location for the XMPP/HTTP Gateway

If you choose to use a location for logs other than the default,
you need to modify the location of the default log file for the XMPP/HTTP
gateway in httpbind_log4j.conf.

Open the httpbind_log4j.conf file.

This
file is stored at the location you specified in httpbind.conf file
as the value for the httpbind.log4j.config parameter.
By default the file is stored in the following directory under the default Instant Messaging instance:

im-cfg-base/httpbind_log4j.conf

Set the value of the log4.appender.appender_ID.file parameter
to the location where log files are stored.

To Set the XMPP/HTTP Gateway Logging Level

Before You Begin

This
file is stored at the location you specified in httpbind.conf file
as the value for the httpbind.log4j.config parameter.
By default the file is stored in the following directory under the default Instant Messaging instance: