See information about the latest product version
Proxy servlet configuration parameters
Before you can deploy the proxy servlet web.xml to the servlet container, you must configure it with the following initialization parameters for the broker environment that the servlet connects to.
This topic contains the following sections:
General options
Parameter name | Default value | Description |
---|---|---|
brokerName | * (auto-detect from config data for broker) |
broker name or “*” Use this parameter to set the name used for error messages; the value is auto-detected if set to "*"'. Set a value if several brokers are being proxied, and a single name is required for error messages. |
configFilePath | /var/mqsi/components/MB8BROKER/config/wsplugin6.conf |
full path to config file If the proxied broker is local, set this parameter to the wsplugin6.conf file (for HTTP nodes) or the soapplugin6.conf (for SOAP nodes) for the broker. This file is used only when the parameter useQueueManagerDataInsteadOfConfigFile is set to blank. The configuration file can be used only when the proxy servlet is running on the same server as the broker, 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\broker_ name\config\wsplugin6.conf. On Linux and UNIX, the file is stored in /var/mqsi/config/wsplugin.conf or in /var/mqsi/components/broker_ name/config/wsplugin6.conf. |
useFastpathBindingsConnection | false |
true or false Causes the servlet to connect in fastpath mode, if using a local queue manager. |
traceFileName | full path to trace file Specify the location and name of the trace file. If this parameter is not specified the trace is sent to stdout. |
|
turnTraceOn | 0 |
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 (WebSphere® Message Broker Version 6.1 FP 4 or later) |
false |
true or false Switches display of the status page. When true, the page is visible at http://hostname:port/proxy_context/messagebroker/httpproxy/statuspage |
enableInfoHeaders (WebSphere Message Broker Version 6.1 FP 4 or later) |
false |
true or false Causes the servlet to add extra headers in the response. These headers are: X-WMB-Broker-Name X-WMB-QM-Name X-WMB-MQ-URL-CorrelId and contain details of the configuration used for that message. |
ReplyToQ and QMgr options
Parameter name | Default value | Description |
---|---|---|
useClusterMode | false |
true or false Set to true if the servlet is required to put reply-to queue and queue manager information in the MQMD of sent messages to enable the broker to respond to the correct queue manager in a cluster. |
clusterModeQueueManagerName | SOME_OTHER_ QUEUE_MANAGER |
queue manager name Queue manager name for initial MQCONN and ReplyToQMgr. |
clusterModeReplyToQ | OUR.REPLYTO.QUEUE |
reply queue name Queue name on which to listen. |
SSL connection options
Parameter name | Default value | Description |
---|---|---|
useSecuredChannel | false |
true or false Set the value of useSecuredChannel to true if SSL is configured on MQ Channel. If set to true, the servlet attempts to establish a secured connection to the MQ Channel by using the keyStore, keyStorePassword, trustStore, trustStorePassword, and cipherSuite parameter values. |
keyStore | full path to the keystore file The fully qualified path to the key store file, which is of type "JKS". For example, in Windows: C:\\Program Files\\IBM\\MQSI\\keystore.jks On Linux and UNIX: /var/mqsi/keystore.jks |
|
keyStorePassword | changeit |
The password to the keystore file. |
trustStore | full path to 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 and UNIX: /var/mqsi/truststore.jks This field is mandatory if useSecuredChannel is set to true. |
|
trustStorePassword | changeit |
The password to the truststore file. |
cipherSuite | 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 |
true or false Use WebSphere MQ client (true) or bindings connection (false). Normally, useQueueManagerDataInsteadOfConfigFile would also be set to the broker queue manager if this parameter is set to true. |
clientModeHostname | localhost |
hostname or IP address Hostname or IP for the Queue Manager. |
clientModeChannelName | SYSTEM.DEF. SVRCONN |
WebSphere MQ SVRCONN channel name The name of the WebSphere MQ SVRCONN to use. |
clientModePortNumber | 1414 |
port number WebSphere MQ listener port number. |
clientModeConnectRetryCount (WebSphere Message Broker Version 6.1 FP 4 or later) |
1 |
integer Number of times to retry the WebSphere MQ connect call. Use this parameter in cases where a network dispatcher or load balancer is being used to distribute work to a set of queue managers and one fails. A new connect 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 | queue manager name, “*”, or blank Queue manager name, ‘*' (remote proxy), or blank for none (local proxy). This option causes the servlet to read Web address data from a queue, and avoid the need for a config file to be accessible from the servlet. |
|
sleepBeforeGet | 0 |
time in seconds Sleep time in seconds. This value causes the servlet to wait before issuing an MQGET for a response message from the broker. |
disconnectBeforeSleep | true |
true or false To release WebSphere MQ handle while sleeping. Useful for keeping the number of simultaneous WebSphere MQ connections down. |
reconnectActiveLinksAge (WebSphere Message Broker Version 6.1 FP 4 or later) |
-1 |
time in seconds, 0, or -1 If set to a number greater than zero, this parameter causes WebSphere 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. Setting this to -1 prevents this reconnection. Setting it to 0 causes all connections to be used once only. This parameter is of most use if the connection to WebSphere MQ goes through a firewall that closes connections after a period of inactivity. Setting this parameter to a value less than the firewall timeout might prevent clients from getting WebSphere MQ 2009 (connection broken) errors. |
testConnectionBeforeReuse (WebSphere Message Broker Version 6.1 FP 4 or later) |
false |
true or false If set to true, the servlet attempts an MQINQ before doing the MQPUT of the HTTP data message. All problems with a cached WebSphere 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 problems have been seen with dropped connections, which are usually seen as WebSphere MQ 2009 errors, indicating connection broken. |
maximumConnectionAge (WebSphere Message Broker Version 6.1 FP 6 or later) |
-1 |
time in seconds, 0, or -1 If set to a number greater than zero, this parameter causes WebSphere MQ connections to be disconnected and reconnected if they are older than the specified number of seconds. Setting this parameter to -1 prevents these reconnections; setting this parameter to 0 causes all connections to be used only once. This parameter is of most use, if the frequent changes to the WebSphere MQ connection parameters are expected due to redeploys of the WebSphere Message Broker flows and you require the ProxyServlet to reflect these changes within the specified number of seconds. |
You can define one or more mappings that are supported by the proxy servlet. These mappings are used by the servlet container to filter Web address requests before executing the correct instance of the proxy servlet.
The mappings are the /node_url_path paths described in HTTP proxy servlet; web addresses component (/url_path=/context_root/node_url_path).
You can define a /node_url_path equal to "/*" to accept Web address paths similar to this example: /HTTPMyBrkServletProxy/your_value.