WebSphere MQ Provider topic connection factory settings for application clients

Name

The name by which this topic connection factory is known for administrative purposes within WebSphere Application Server. The name must be unique within the JMS provider.

Data type

String

Description

A description of this topic connection factory for administrative purposes within WebSphere Application Server.

Data type

String

JNDI Name

The Java Naming and Directory Interface (JNDI) name that is used to bind the topic connection factory into the application server name space.

As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource.

This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.

Data type	String
Units	En_US ASCII characters
Range	1 through 45 ASCII characters

User ID

The user ID used, with the password property, for authentication if the calling application does not provide a user ID and password explicitly.

If you specify a value for the user ID property, you must also specify a value for the password property.

The connection factory user ID and password properties are used if the calling application does not provide a user ID and password explicitly, for example, if the calling application uses the method createTopicConnection(). The JMS client flows the user ID and password to the JMS server.

Data type

String

Password

The password used, with the user ID property, for authentication if the calling application does not provide a user ID and password explicitly.

If you specify a value for the user ID property, you must also specify a value for the password property.

Data type

String

Re-Enter Password

Confirms the password.

Queue Manager

The name of the WebSphere MQ queue manager for this connection factory. Connections created by this connection factory connect to this queue manager.

Data type

String

Enter Hostname and Port Information

This radio button is selected by default and, if selected, enables the host and port properties and disables the connection name list property.

Data type	Radio button
Default	Selected

Host

The name of the host on which the WebSphere MQ queue manager runs for client connections only.

Data type	String
Range	A valid TCP/IP host name

Port

The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only.

This port must be configured on the WebSphere MQ queue manager.

Data type	Integer
Range	A valid TCP/IP port number, configured on the WebSphere MQ queue manager.

Enter Connection Name List Information

If selected, this radio button enables the connection name list property and disables the host and port name properties. Select this radio button if you want to connect to a multi-instance queue manager.

Data type	Radio button
Default	Cleared

Connection Name List

A comma-separated list of host and port information which can be used to connect to a multi-instance queue manager.

The format of the list is:

host[(port)],[host[(port)]]

where port is optional and defaults to 1414 if it is not set. For example:

hostname1,hostname2(1415)

For further information about multi-instance queue managers, see the WebSphere MQ information center.

This property must only be used for connecting to a multi-instance queue manager. It must not be used for connecting to a list of distinct queue managers as that can result in transaction integrity issues.

Channel

The name of the channel used for client connections to the WebSphere MQ queue manager, for client connection only.

Data type	String
Range	1 through 20 ASCII characters

Transport Type

Whether WebSphere MQ client connection or JNDI bindings are used for connection to the WebSphere MQ queue manager.

Data type	Enum
Default	BINDINGS
Range	CLIENT WebSphere MQ client connection is used to connect to the WebSphere MQ queue manager. BINDINGS JNDI bindings are used to connect to the WebSphere MQ queue manager.

Client ID

The JMS client identifier used for connections to the WebSphere MQ queue manager.

Data type

String

CCSID

The coded character set identifier to use with the WebSphere MQ queue manager.

This coded character set identifier (CCSID) must be one of the CCSIDs that WebSphere MQ supports. See the properties for the topic connection factory for more details.

Data type	String
Units	Integer
Range	1 through 65535

Broker Control Queue

The name of the broker control queue to which all command messages (except publications and requests to delete publications) are sent.

Data type	String
Units	En_US ASCII characters
Range	1 through 48 ASCII characters

Broker Queue Manager

The name of the WebSphere MQ queue manager that provides the Publisher and Subscriber message broker.

Data type	String
Units	En_US ASCII characters
Range	1 through 48 ASCII characters

Broker Publish Queue

The name of the broker input queue that receives all publication messages for the default stream.

The name of the broker's input queue (stream queue) that receives all publication messages for the default stream. Applications can also send requests to delete publications on the default stream to this queue.

Data type	String
Units	En_US ASCII characters
Range	1 through 48 ASCII characters

Broker Subscribe Queue

The name of the broker queue from which nondurable subscription messages are retrieved.

The name of the broker queue from which nondurable subscription messages are retrieved. The subscriber specifies the name of the queue when it registers a subscription.

Data type	String
Units	En_US ASCII characters
Range	1 through 48 ASCII characters

Broker CCSubQ

The name of the broker queue from which nondurable subscription messages are retrieved for a ConnectionConsumer request. This property applies only for use of the web container.

Data type	String
Units	En_US ASCII characters
Range	1 through 48 ASCII characters

Broker Version

Whether the message broker is provided by the WebSphere MQ MA0C SupportPac™ or newer versions of WebSphere family message broker products.

Data type	Enum
Default	Advanced
Range	Advanced The message broker is provided by newer versions of WebSphere family message broker products (MQ Integrator and MQ Publish and Subscribe). Basic The message broker is provided by the WebSphere MQ MA0C SupportPac (WebSphere MQ - Publish and Subscribe).

Cleanup level

The level of clean up provided by the publish or subscribe cleanup utility.

Data type	Enum
Default	SAFE
Range	ASPROP NONE STRONG

Cleanup interval

The interval, in milliseconds, between background executions of the publish/subscribe cleanup utility.

Data type	Integer
Units	Milliseconds
Default	6000

Message selection

Where broker message selection is performed.

Data type	Enum
Default	BROKER
Range	BROKER Message selection is performed at the broker location. Message CLIENT Message selection is performed at the client location.

Publish acknowledge interval

The interval, in number of messages, between publish requests that require acknowledgement from the broker.

Data type	Integer
Default	25

Sparse subscriptions

Enables sparse subscriptions.

Data type	Check box
Default	Cleared

Status refresh interval

The interval, in milliseconds, between transactions to refresh publish or subscribe status.

Data type	Integer
Default	6000

Subscription store

Where WebSphere MQ stores data relating to active JMS subscriptions.

Data type	Enum
Default	MIGRATE
Range	MIGRATE QUEUE BROKER

Multicast

Whether this connection factory uses multicast transport.

Data type	Enum
Default	NOT USED
Range	NOT USED This connection factory does not use multicast transport. ENABLED This connection factory always uses multicast transport. ENABLED_IF_AVAILABLE This connection factory uses multicast transport. ENABLED_RELIABLE This connection factory uses reliable multicast transport. ENABLED_RELIABLE_IF_AVAILABLE This connection factory uses reliable multicast transport if available.

Direct authentication

Whether to use direct broker authorization.

Data type	Enum
Default	NONE
Range	NONE Direct broker authorization is not used. PASSWORD Direct broker authorization is authenticated with a password. CERTIFICATE Direct broker authorization is authenticated with a certificates.

Proxy Host Name

The host name of a proxy to be used for communication with WebSphere MQ.

Data type

String

Proxy Port

The port number of a proxy to be used for communication with WebSphere MQ.

Data type	Integer
Default	0

Fail if quiesce

Whether applications return from a method call if the queue manager has entered a controlled failure.

Data type	Check box
Default	Selected

Local Server Address

The local server address.

Data type

String

Polling Interval

The interval, in milliseconds, between scans of all receivers during asynchronous message delivery.

Data type	Integer
Units	Milliseconds
Default	5000

Rescan interval

The interval in milliseconds between which a topic is scanned to look for messages that have been added to a topic out of order.

The rescan interval controls the scanning for messages that have been added to a topic out of order with respect to a WebSphere MQ browse cursor.

Data type	Integer
Units	Milliseconds
Default	5000

SSL cipher suite

The cipher suite to use for SSL connection to WebSphere MQ.

Set this property to a valid cipher suite provided by your JSSE provider. The value must match the CipherSpec specified on the SVRCONN channel as the Channel property.

You must set this property, if you set the SSL Peer Name property.

SSL certificate store

A list of zero or more Certificate Revocation List (CRL) servers that are used to check for SSL certificate revocation. If you specify a value for this property, you must use WebSphere MQ JVM at Java 2 version 1.4.

The value is a space-delimited list of entries of the form:

ldap://hostname:[port]

A single slash (/) follows this value. If port is omitted, the default LDAP port of 389 is assumed. At connect-time, the SSL certificate presented by the server is checked against the specified CRL servers. For more information about CRL security, see the information about "Working with Certificate Revocation Lists" in the Security section of the WebSphere MQ information center.

SSL peer name

For SSL, a distinguished name skeleton that must match the name provided by the WebSphere MQ queue manager. The distinguished name is used to check the identifying certificate presented by the server at connection time.

If this property is not set, such certificate checking is performed.

The SSL peer name property is ignored if SSL Cipher Suite property is not specified.

This property is a list of attribute name and value pairs separated by commas or semicolons. For example:

CN=QMGR.*, OU=IBM, OU=WEBSPHERE

The example given checks the identifying certificate presented by the server at connect-time. For the connection to succeed, the certificate must have a Common Name beginning QMGR., and must have at least two Organizational Unit names, the first of which is IBM and the second WEBSPHERE. Checking is not case-sensitive.

For more details about distinguished names and their use with WebSphere MQ, see the information about "Distinguished Names" in the Security section of the WebSphere MQ information center.

Connection pool

An optional set of connection pool settings.

Connection pool properties are common to all J2C connectors.

The application server pools connections and sessions with the JMS provider to improve performance. This is independent from any WebSphere MQ connection pooling. You need to configure the connection and session pool properties appropriately for your applications, otherwise you may not get the connection and session behavior that you want.

Change the size of the connection pool if concurrent server-side access to the JMS resource exceeds the default value. The size of the connection pool is set on a per queue or topic basis.

Data type	Check box
Default	Selected

Client reconnect options

Specifies whether a client mode connection reconnects automatically, or not, in the event of a communications or queue manager failure. This property is ignored unless the connection factory is being used in a thin or managed client environment.

Data type	Drop-down list
Default	DISABLED
Range	DISABLED The client reconnection does not automatically occur. ASDEF The value from the DefRecon attribute from the channels stanza of the client configuration file is used. If there is no DefRecon value specified then this setting has the same effect as a value of DISABLED. RECONNECT Reconnection occurs to any queue manager consistent with the value of the queue manager attribute, which might be a different queue manager from that to which the connection was originally connected. QMGR Reconnection only occurs to the queue manager to which the connection was originally connected.

For more information about automatic client reconnection, see the WebSphere MQ information center.

Client reconnect timeout

The maximum amount of time, in seconds, that a client mode connection will spend attempting to automatically reconnect to a queue manager after a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Whether this parameter is used or not depends on the value of the client reconnect options parameter.

Data type	Integer
Units	Seconds
Default	1800
Range	A value greater than zero and up to 2147483647

For more information about automatic client reconnection, see the WebSphere MQ information center.