IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Broker-wide HTTP listener parameters

Select the resources and properties that are associated with the broker-wide HTTP listener that you want to change.

To change these properties, you must specify the broker name and -b httplistener.

The httplistener component defines properties for the broker that are used for all the HTTP and SOAP input and reply nodes that are configured to use the broker-wide listener.

You must restart the broker for all changes to be implemented.

The following combinations are valid for the httplistener component:

-o HTTPListener

The following properties and values are valid:
-n enableSSLConnector
Set the value to true to make the HTTP listener listen for inbound SSL connections.
  • Value type - Boolean
  • Initial value - false
-n startListener
Set the value to true to make all HTTP nodes in all integration servers use the broker-wide listener (unless you activated the embedded listener in an integration server by using the mqsichangeproperties command for that integration server). For information about configuring an integration server so that HTTP nodes can use the embedded listener, see Integration server HTTP listener parameters (SOAP and HTTP nodes).

SOAP nodes use the embedded listener by default, but can be configured to use the broker-wide listener by using the mqsichangeproperties command. See Switching from a broker-wide listener to embedded listeners.

Set this value to false to make all HTTP nodes use the listener that is embedded within each integration server.

  • Value type - Boolean
  • Initial value -true

-o HTTPConnector

The following properties and values are valid:
-n address
If your server has more than one IP address, set the value to the IP address that is used for listening on port 7080. If this property is not set, port 7080 is used on all IP addresses associated with the server. A maximum of one address can be specified.
  • Value type - string
  • Initial value - null
-n maxPostSize
Set the value to the maximum POST size (in bytes) that can be processed by the broker-wide listener. Set the value to 0 to remove the limit.
  • Value type - integer
  • Initial value - 2097152 (2 megabytes)
-n acceptCount
Set the value to the maximum number of incoming connection requests that can be queued. Requests that are received when this limit is reached are rejected.
  • Value type - integer
  • Initial value - 100
-n compressableMimeTypes
Set the value to a list of MIME types that are applicable for HTTP compression. Other MIME types are not compressed.
  • Value type - comma-separated list
  • Initial value - text/html,text/xml,text/plain
-n compression
Set the value to off to disable compression, on to compress text data, force to compress all data, or the minimum size (in bytes) of data that must be received, before the output is compressed. If compression is enabled and the content-length is not known, all the output is compressed.
  • Value type - string
  • Initial value - off
    Note: For the webadmin component, compression is turned on by default for new brokers.
-n connectionLinger
Set the value to the number of seconds for which the sockets (used by the HTTPConnector) must remain active after a shutdown is initiated.
  • Value type - integer
  • Initial value - JVM default
-n connectionTimeout
Set the value to the number of milliseconds the HTTPConnector must wait for a request to be received after it accepts a connection. Set the value to -1 to specify no timeout.
  • Value type - integer
  • Initial value - 60000
-n maxHttpHeaderSize
Set the value to the maximum size (in bytes) that the HTTPListener accepts for an HTTP header.
  • Value type - integer
  • Initial value - 8192 (8 kilobytes)
-n maxKeepAliveRequests
Set the value to the maximum number of requests that can use a persistent connection. Set the value to 1 to disable keep-alive requests and force the creation of a new connection for each request. Set the value to 0 or -1 to allow unlimited requests.
  • Value type - integer
  • Initial value - 100
-n maxThreads
Set the value to the maximum number of threads that can be created by the HTTPConnector.
  • Value type - integer
  • Initial value - 200
-n minSpareThreads
Set the value to the minimum number of threads that must be active.
  • Value type - integer
  • Initial value - 10
-n noCompressionUserAgents
Set the value to a regular expression that, when matched with the user-agent header, disables compression.
  • Value type - string
  • Initial value - null
-n restrictedUserAgents
Set the value to a regular expression that, when matched with the user-agent header, disables keep-alive.
  • Value type - string
  • Initial value - null
-n serverName
Set the value that is set in the "Server" header for all HTTP responses sent by this server.
  • Value type - string
  • Initial value - Apache-Coyote/1.1
-n socketBuffer
Set the value to the size (in bytes) of the buffer that must be used for socket output buffering. Set the value to -1 to disable the use of a buffer.
  • Value type - integer
  • Initial value - 9000 (9 kilobytes)
-n tcpNoDelay
Set the value to true, to send small packets immediately.
  • Value type - Boolean
  • Initial value - true
-n enableLookups
Set the value to true to use DNS lookups to return the host name of the remote client. Set the value to false to return the IP address instead.
  • Value type - Boolean
  • Initial value - false
-n accessLog
Set the value to true to enable access valve logging. When it is enabled, access valve logging generates a web server access log in the $MQSI_WORKPATH/components/<Integration_node_name>/httplistener directory. The log provides details of all accesses to the URIs that are served by the broker-wide HTTP listener.

You can customize the format of entries in the web server access log by using the accessLogPattern property.

  • Value type - Boolean
  • Initial value - false
-n accessLogPattern

Set the value to customize the format of entries in the access log that is enabled by the accessLog property. Ensure that the value is in the same format as the format described in the Apache Tomcat 7 documentation.

The following header, which provides performance measurement information about the time that a request has spent waiting in the broker-wide HTTP listener, is also supported:
%{X-IIB-Timing}o
  • Value type - string
  • Initial value - null

-o HTTPSConnector

The properties that are listed for the HTTPConnector are also valid for the HTTPSConnector. The following additional properties and values are valid for the HTTPSConnector:
-n algorithm
Set the value to the certificate-encoding algorithm to use.
  • Value type - string
  • Initial value -
    • Solaris platformHP-UX platformSunX509 on Solaris and HP-UX
    • AIX platformz/OS platformLinux platformWindows platformIbmX509 on other systems (AIX®, Linux, Windows, z/OS®)
-n clientAuth
Set the value to true if a valid SSL certificate must be received from the client before a connection can be accepted.
  • Value type - Boolean
  • Initial value - false
-n keystoreFile
Set the value to the path and file name of the keystore file where the server certificate is stored.
  • Value type - string
  • Initial value - platform default
-n keystorePass
Set the value to the password that is used to access the server certificate in the keystore file. The value can either be a plaintext password or, if the value is prefixed with "brokerKeystore::", the password is the named value that is configured by the mqsisetdbparms command.
  • Value type - string
  • Initial value - changeit
-n keystoreType
Set the value to the type of keystore file used.
  • Value type - string
  • Initial value - JKS
-n truststoreFile
Set the value to the path and file name of the truststore file.
  • Value type - string
  • Initial value - platform default
-n truststorePass
Set the value to the password used to access the truststore file. The value can either be a plaintext password or, if the value is prefixed with "brokerTruststore::", the password is the named value that is configured by the mqsisetdbparms command.
  • Value type - string
  • Initial value - changeit
-n truststoreType
Set the value to the type of truststore file used.
  • Value type - string
  • Initial value - JKS
-n sslProtocol
Set the value to the version of the SSL protocol to use.
  • Value type - string
  • Initial value - TLS
From Integration Bus V9.0.0.3 onwards, SSLv3 is disabled due to the Poodle vulnerability. Therefore TLS is set as the default protocol. Versions of Integration Bus earlier than V9.0.0.3 the default protocol is still SSLv3.
-n ciphers
Set the value to a list of the encryption ciphers that can be used. If no value is set, any available cipher is used. The client sends a list of ciphers in priority order. The server selects the first acceptable cipher in the list. If none of the ciphers in the list are suitable, the server returns a handshake failure alert and closes the connection.
  • Value type - comma-separated list
  • Initial value - null
-n keyAlias
Set the value to the alias that is given to the server certificate in the keystore. By default, the first key in the keystore is used.
  • Value type - string
  • Initial value - null
-n keypass
Set the value to the password that is used to access the server certificate in the keystore file. The value can either be a plaintext password or, if the value is prefixed with "brokerKeystore::keypass", the password is the named value that is configured by the mqsisetdbparms command.
  • Value type - string
  • Initial value - changeit
-n sessionCacheSize
Set the value to the maximum number of sessions that you allow in the SSL Session Cache. These cached sessions are available for SSL session renegotiation.
  • Value type - integer
  • Initial value - 100
-n maxSavePostSize
Set the value to the maximum size in bytes that can be buffered during FORM or CLIENT-CERT authentication.
  • Value type - integer
  • Initial value - 2097152 (2MB)
Tip: The valid values for keystoreType, sslProtocol, and ciphers are JSSE-implementation-specific. These values are in the JSSE provider documentation. For a list of the platforms that use IBM® Java™, see Appendix A of the IBM JSSE2 Guide, at: http://www.ibm.com/support/knowledgecenter/SSYKE2_6.0.0/com.ibm.java.security.component.60.doc/security-component/jsse2Docs/ibmjsse2.html.

See the mqsichangeproperties command for examples of how to change parameters for the httplistener component.


an09141_.htm | Last updated Friday, 21 July 2017