Class MQEnvironment

The security exit used when connecting to a queue manager. It allows you to customise the security flows that occur when an attempt is made to connect to a queue manager.

If you want to provide your own security exit, define a class that implements either:- MQSecurityExit, WMQSecurityExit interface or String and assign securityExit to an instance of that class or the class definition to the string.

If you set this field to null no security exit is called.

The send exit used when sending messages to a queue manager. It allows you to examine, and possibly alter, data and is normally used in conjunction with a corresponding receive exit at the queue manager.

If you want to provide your own send exit, define a class that implements either:- MQSendExit, WMQSendExit interface or List or String and assign sendExit to an instance of that class or the class definition to the string.

If you set this field to null no send exit is called.

The receive exit used when receiving messages from a queue manager. It allows you to examine, and possibly alter, data and is normally used in conjunction with a corresponding send exit at the queue manager.

If you want to provide your own send exit, define a class that implements either:- MQReceiveExit, WMQReceiveExit interface or List ro String and assign receiveExit to an instance of that class or the class definition to the string.

If you set this field to null no receive exit is called.

When defining Java security, send or receive exit as strings to be loaded by the class loader, the path that has the class or jar that contains the class has to be known to the loader. The loader uses the system property com.ibm.mq.exitClasspath to find the classes. This property can be used by the client application to add the path of the class that will be dynamically loaded.

The TCP/IP hostname of the machine on which the WebSphere MQ server resides. If the hostname is not set, and no overriding properties are set, bindings mode is used to connect to the local queue manager.

The port to be used. This is the port on which Websphere MQ listens for connection requests.

The default value is 1414.

The name of the channel to connect to on the target queue manager. It does not apply when connecting directly to WebSphere MQ in bindings mode. You must set this field, or the corresponding property, before constructing an MQQueueManager instance for use in client mode.

The ID used to identify the WebSphere MQ client. It is equivalent to the WebSphere MQ environment variable MQ_USER_ID.

The default value is "" (the empty string).

If no security exit is defined for this client and userID is set to "" (the empty string), the WebSphere MQ classes for Java will query the Java System Property "user.name" and transmit this to the server.

If no security exit is defined for this client and userID has been set to a value other than "" (the empty string), then this value will be transmitted to the server.

If a security exit is defined for this client, then it is the responsibility of the exit to apply any application specific security logic. The value of userID is not made available to the exit and is not transmitted to the server.

The password used to verify the identity of the WebSphere MQ Client. It is equivalent to the MQ environment variable MQ_PASSWORD.

If a security exit is not defined for this client, the value of password is transmitted to the server and is available to the server security exit when it is invoked.

The default value is "" (empty string).

A URL specifying the location of a Client Channel Definition Table (CCDT) to define the connection properties.

The CCSID used by the client. It does not apply when connecting directly to WebSphere MQ in bindings mode.

Changing this value affects the way that the queue manager you connect to translates information in the WebSphere MQ headers. All data in WebSphere MQ headers is drawn from the invariant part of the ASCII codeset, except for the data in the MQMessage.applicationIdDataand MQMessage.putApplicationNamefields.

If you avoid using characters from the variant part of the ASCII codeset for these two fields, then the CCSID can be changed from 819 to any other ASCII codeset.

If you change the client CCSID to be the same as that of the queue manager to which you are connecting, you gain a performance benefit at the queue manager because it does not attempt to translate the message headers. For the reasons outlined above, this only applies to ASCII codesets - you must not set the CCSID to an EBCDIC-based value when communicating with a queue manager using EBCDIC.

The default value is 819.

The list of supported compressors for header compression. Possible values are:

• MQC.MQCOMPRESS_NONE
• MQC.MQCOMPRESS_SYSTEM

The list of supported compressors for message compression. Possible values are:

• MQC.MQCOMPRESS_NONE, the default.
• MQC.MQCOMPRESS_RLE.
• MQC.MQCOMPRESS_ZLIBFAST.
• MQC.MQCOMPRESS_ZLIBHIGH.

The name of the Cipher Suite to be used by SSL. SSL is only valid for a client connection and is triggered by setting sslCipherSuite. If sslCipherSuite is not set, all of the other values are irrelevant and a standard non-SSL connection is used to connect to the server.

The Distinguished Name (DN) of the queue manager to be used by SSL. The peer name is set to indicate that connections should only be allowed where the server is successfully authenticated as a specific DN.

Collection of SSL CertStores. The collection of CertStores (J2SE 1.4 only) is used to enable WebSphere MQ Java clients to check certificates for revocation in a Certificate Revocation List (CRL).

The factory to use when connecting with SSL encryption. If sslCipherSuite is set, this variable can be used to customize all aspects of the SSL connection.

For more information on constructing and customizing SSLSocketFactory instances, refer to your JSSE provider.

If set to null (default) and SSL encryption is requested, the default SSLSocketFactory is used.

This variable is ignored if sslCipherSuiteis null.

The total number of unencrypted bytes that are sent and received by the initiating channel MCA before the secret key is reset. The number of bytes includes control information sent by the message channel agent. A value of 0 disables secret key reset from occurring.

When this is set to true, the only Cipher Suites that can be used on an SSL connection from this client process are those which are FIPS-enabled. In this case, if and a customized sslSocketFactory has been specified the customized sslSocketFactory will not be used, as it cannot be guaranteed that the sslSocketFactory is FIPS compliant.

The local address, including a range of ports, used when connecting to a WebSphere MQ queue manager through a firewall. The format is [ip-addr][(low-port[,high-port])].

Here are some examples:

9.20.4.98

The channel binds to address 9.20.4.98 locally

9.20.4.98(1000)

The channel binds to address 9.20.4.98 locally and uses port 1000

9.20.4.98(1000,2000)

The channel binds to address 9.20.4.98 locally and uses a port in the range 1000 to 2000

(1000)

The channel binds to port 1000 locally

(1000,2000)

The channel binds to a port in the range 1000 to 2000 locally

You can specify a host name instead of an IP address. The variable is initialized from system property com.ibm.mq.localAddress when you start the JVM. The default value is null.

The connection tag which allows users to serialize access to the resources they are using on a z/OS queue manager. The connTag String is truncated to 128 bytes. connTag is ignored if connOptionsis not set.

The queue manager connection options. Possible values are:

• MQC.MQCNO_STANDARD_BINDING
• MQC.MQCNO_FASTPATH_BINDING
• MQC.MQCNO_ISOLATED_BINDING
• MQC.MQCNO_SHARED_BINDING
• MQC.MQCNO_RESTRICT_CONN_TAG_Q_MGR
• MQC.MQCNO_RESTRICT_CONN_TAG_QSG
• MQC.MQCNO_SERIALIZE_CONN_TAG_Q_MGR
• MQC.MQCNO_SERIALIZE_CONN_TAG_QSG

The number of conversations per connection. Allows user to turn multiplexing ON or OFF. A value of 0 turns multiplexing off.

A Hashtable which defines the WebSphere MQ environment.

This Hashtable allows you to set environment properties as key/value pairs rather than as individual variables.

The properties can also be passed as a Hashtable in a parameter on the MQQueueManagerconstructor. Properties passed on the constructor take precedence over values set with this properties variable, but they are otherwise interchangeable. The order of precedence of finding properties is:

1. properties parameter on MQQueueManager constructor
2. MQEnvironment.properties
3. Other MQEnvironment variables
4. Constant default values

The property key names are:

MQC.CCDT_URL_PROPERTY

overrides ccdtUrlProperty.

MQC.CCSID_PROPERTY

overrides CCSID.

MQC.CHANNEL_PROPERTY

overrides channel.

MQC.CONNECT_OPTIONS_PROPERTY

overrides connOptions.

MQC.CONNTAG_PROPERTY

overrides connTag.

MQC.HEADER_COMPRESSION_PROPERTY

overrides hdrCompList.

MQC.MESSAGE_COMPRESSION_PROPERTY

overrides msgCompList.

MQC.HOST_NAME_PROPERTY

overrides hostname.

MQC.LOCAL_ADDRESS_PROPERTY

overrides localAddressSetting.

MQC.PASSWORD_PROPERTY

overrides password.

MQC.PORT_PROPERTY

overrides port.

MQC.RECEIVE_EXIT_PROPERTY

overrides receiveExit.

MQC.SECURITY_EXIT_PROPERTY

overrides securityExit.

MQC.SEND_EXIT_PROPERTY

overrides sendExit.

MQC.SSL_CERT_STORE_PROPERTY

overrides sslCertStores.

MQC.SSL_CIPHER_SUITE_PROPERTY

overrides sslCipherSuite.

MQC.SSL_FIPS_REQUIRED

overrides sslFipsRequired.

MQC.SSL_RESET_COUNT_PROPERTY.

overrides sslResetCount.

MQC.SSL_PEER_NAME_PROPERTY.

overrides sslPeerName.

MQC.SSL_SOCKET_FACTORY_PROPERTY

overrides sslSocketFactory.

MQC.TRANSPORT_PROPERTY

forces MQC.TRANSPORT_MQSERIES_BINDINGSor MQC.TRANSPORT_MQSERIES_CLIENT.

MQC.USER_ID_PROPERTY

overrides userID.

MQC.SHARING_CONVERSATIONS_PROPERTY

overrides sharingConversations.

Constructor

Gets the current version of the Websphere MQ Java Classes.

Turns on tracing to console & (default) file

This method turns off the WebSphere MQ Client for Java trace facility.

Sets the default MQConnectionManager, and empties the set of MQPoolTokens. The default ConnectionManager is used when no ConnectionManager is specified on the MQQueueManager constructor.

Sets the default ConnectionManager, and empties the set of MQPoolTokens. The default ConnectionManager is used when no ConnectionManager is specified on the MQQueueManager constructor. This method requires a JVM at Java 2 v1.3 or later, with JAAS 1.0 or later installed.

Gets the default ConnectionManager.

Adds a given MQPoolToken to the connection pool. A default ConnectionManager can use this as a hint; typically, it is enabled only while there is at least one token in the connection pool.

Constructs an MQPoolToken and adds it to the set of tokens. The token is returned to the application to be passed later into the removeConnectionPoolToken()method.

Removes a token from the connection pool.

Returns an MQQueueManagerobject reference if one is available within the specified scope. The scope must be one of MQC.ASSOCIATE_ALLor MQC.ASSOCIATE_THREAD, and a queue manager must already have been created with MQC.MQ_QMGR_ASSOCIATION_PROPERTYset to the scope requested.

If no queue manager has been created within the specified scope, or if MQC.ASSOCIATE_NONEis specified, this method will return null.

A call to this method is the same as calling MQEnvironment.getQueueManagerReference(int, Object) with a null Object.

Returns an MQQueueManagerobject reference if one is available within the specified scope. The scope must be one of MQC.ASSOCIATE_ALLor MQC.ASSOCIATE_THREAD, and a queue manager must already have been created with MQC.MQ_QMGR_ASSOCIATION_PROPERTYset to the scope requested. The supplied Object gives information necessary to identify the MQQueueManager within the scope; for MQC.ASSOCIATE_ALL and MQC.ASSOCIATE_THREAD this Object must be a String containing the name of the queue manager.

If no queue manager identified by the supplied Object has been created within the specified scope, or if MQC.ASSOCIATE_NONEis specified, this method will return null.

An MQQueueManager object returned by this method will refer to the same underlying HConn as the MQQueueManager created with MQC.MQ_QMGR_ASSOCIATION_PROPERTY set, and both will therefore share the same transaction context. If an attempt is made to create a second MQQueueManager object on the same context to a different queue manager, then a separate HConn will be made, and the first and second object will have independent transaction contexts. These contexts will extend to WebSphere MQ coordinated JDBC transactions by using MQQueueManager.getJDBCConnection(XADataSource) on the appropriate queue manager.