HTTP proxy servlet configuration parameters

Before you can deploy the HTTP proxy servlet to the servlet container, you must configure it with the following initialization parameters for the integration node environment to which the HTTP proxy servlet connects.

General options

Parameter name Default value Description

brokerName

*

Set to * or the name of your integration node.

Use this parameter to specify the name that is used for error messages; the value is auto-detected if set to "*"'.

Specify a value if several integration nodes are being used by the HTTP proxy servlet, and a single name is required for error messages.

configFilePath

/var/mqsi/components/IBNODE/config/wsplugin6.conf

Specify the full path of the configuration file.

If the integration node that is used by the HTTP proxy servlet is local, set this parameter to the wsplugin6.conf file.

This value is used only when the parameter useQueueManagerDataInsteadOfConfigFile is set to blank. The configuration file is used only when the HTTP proxy servlet is running on the same server as the integration node, and it has access to the file.

In Windows, the file is stored in C:\install_dir\config\wsplugin.conf or C:\Documents and Settings\All Users\IBM\MQSI\components\NodeName\config\wsplugin6.conf where NodeName is the name of your integration node.

On Linux®, the file is stored in /var/mqsi/config/wsplugin.conf or in /var/mqsi/components/NodeName/config/wsplugin6.conf where NodeName is the name of your integration node.

useFastpathBindingsConnection

false

Specify true or false.

Set the value to true to make the HTTP proxy servlet connect in fastpath mode if the HTTP proxy servlet is using a local queue manager.

traceFileName

 

Specify the full path of the trace file.

If this parameter is not specified the trace is sent to stdout.

turnTraceOn

0

Set to 0, 1, or 2.

Set 0 for no trace, 1 for normal trace, or 2 for debug trace.

Information options

Parameter name Default value Description

enableStatusPage

false

Set to true or false.

Set the value to true, to make the page accessible at http://HostName:Port/ContextRoot/messagebroker/httpproxy/statuspage where HostName is the name of your servlet container, Port is the port for your servlet container, and ContextRoot is the context root you have set for your HTTP proxy servlet. For more information about the context root, see Importance of the context root when you configure the HTTP proxy servlet.

enableInfoHeaders

false

Set to true or false.

Set the value to true to make the HTTP proxy servlet add extra headers in the response message. These headers are:
  • X-WMB-Broker-Name
  • X-WMB-QM-Name
  • X-WMB-MQ-URL-CorrelId
The headers also contain details of the configuration that is used for the response message.

ReplyToQ and QMgr options

Parameter name Default value Description

useClusterMode

false

Set to true or false.

Set to true if the HTTP proxy servlet is required to put reply-to queue and queue manager information in the MQMD of sent messages to enable the integration node to respond to the correct queue manager in a cluster.

clusterModeQueueManagerName

SOME_OTHER_ QUEUE_MANAGER

Set to the queue manager name for initial MQCONN and ReplyToQMgr.

clusterModeReplyToQ

OUR.REPLYTO.QUEUE

Set to the reply queue name on which to listen.

SSL connection options

Parameter name Default value Description

useSecuredChannel

false

Set to true or false.

Set to true if SSL is configured on the MQ channel. If set to true, the proxy servlet attempts to establish a secured connection to the MQ channel by using the keyStore, keyStorePassword, trustStore, trustStorePassword, and cipherSuite parameter values.

keyStore

Set to the full path of the keystore file.

The fully qualified path to the keystore file, which is of type "JKS".

For example, in Windows: C:\\Program Files\\IBM\\MQSI\\keystore.jks

On Linux: /var/mqsi/keystore.jks

keyStorePassword

changeit

Set to the password of the keystore file.

trustStore

 

Set to the full path of the truststore file.

The fully qualified path to the truststore file, which is of type "JKS".

For example, on Windows: C:\\Program Files\\IBM\\MQSI\\truststore.jks

On Linux: /var/mqsi/truststore.jks

This field is mandatory if useSecuredChannel is set to true.

trustStorePassword

changeit

Set to the password of the truststore file.

cipherSuite

 

Set to the encryption type that is configured in the MQ channel. For example: SSL_RSA_WITH_NULL_MD5

This field is mandatory if useSecuredChannel is set to true.

MQ connection options

Parameter name Default value Description

useClientMode

false

Set to true or false.

Set the value to true to use the IBM MQ client or set the value to false to use the bindings connection. Normally, useQueueManagerDataInsteadOfConfigFile would also be set to the integration node queue manager if this parameter is set to true.

clientModeHostname

localhost

Set to the host name or the IP address for the queue manager.

clientModeChannelName

SYSTEM.DEF.SVRCONN

Set to the IBM MQ SVRCONN channel name

clientModePortNumber

1414

Set to the port number of the IBM MQ listener.

clientModeConnectRetryCount

1

Specify the number of times to retry the IBM MQ connect call.

Use this parameter in cases where a network dispatcher or load balancer is used to distribute work to a set of queue managers and one of the queue managers fails. A new connect call might fail the first time, but succeed the second time. The retry count must be set to a high number to provide the greatest chance of success.

useQueueManagerDataInsteadOfConfigFile

 

Set to the queue manager name, * (remote proxy), or leave blank (local proxy).

Set this value to the queue manager name to make the HTTP proxy servlet retrieve web address data from a queue, and avoid the need for a configuration file to be accessible by the HTTP proxy servlet.

sleepBeforeGet

0

Set to the time (in seconds) to wait before the HTTP proxy servlet issues an MQGET call for a response message from the integration node.

disconnectBeforeSleep

true

Set to true or false.

Set the value to true to release the IBM MQ handle while sleeping and minimize the number of simultaneous IBM MQ connections.

reconnectActiveLinksAge

-1

Set to a time (in seconds), 0, or -1

Set the value to a number greater than zero to force IBM MQ connections to be disconnected and reconnected if they have been inactive, because of low traffic volumes, for more than the specified number of seconds.

Set the value to -1 to prevent any reconnection.

Set the value to 0 to force all connections to be used only one time.

This parameter is useful if the connection to IBM MQ goes through a firewall that closes connections after a period of inactivity.

Set the value to a value less than the firewall timeout to prevent clients from receiving IBM MQ 2009 (connection broken) error code responses.

testConnectionBeforeReuse

false

Set to true or false.

Set the value to true, to make the HTTP proxy servlet attempt an MQINQ before it does the MQPUT of the HTTP data message. All problems with a cached IBM MQ client connection are detected at that point, and a new connection is established for the MQPUT of the actual data (and MQGET of the response).

This parameter causes significant extra network traffic, and must be used only if there are problems with dropped connections, which are usually seen as IBM MQ 2009 errors, indicating that the connection is broken.

maximumConnectionAge

-1

Set to a time (in seconds), 0, or -1

Set the value to a number greater than zero to disconnect and reconnect IBM MQ connections if they are older than the specified number of seconds.

Set the value to -1 to prevents any reconnections.

Set the value to 0 to use all connections only one time.

This parameter is of most use if the frequent changes to the IBM MQ connection parameters are expected due to redeployment of the IBM Integration Bus flows, and you require the HTTP proxy servlet to reflect these changes within the specified number of seconds.