WebSphere MQ topic connection factory settings

 

To view or change the configuration properties of a topic connection factory for use with the WebSphere MQ JMS provider go to...

Console | Resources | WebSphere MQ JMS Provider | WebSphere MQ Topic Connection Factories | connection_factory

A topic connection factory is used to create JMS connections to topic destinations. The topic connection factory is created by the WebSphere MQ JMS provider. A topic connection factory for the WebSphere MQ JMS provider has the following properties.

Name The name by which this topic connection factory is known for administrative purposes within IBM WAS. The name must be unique within the JMS provider.

Data type String

JNDI name The JNDI name that is used to bind the topic connection factory into the appserver's 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

Description A description of this topic connection factory for administrative purposes within IBM WAS.

Data type String
Default Null

Category A category used to classify or group this topic connection factory, for your IBM WAS administrative records.

Data type String

Component-managed Authentication Alias This alias specifies a user ID and password to be used to authenticate connection to a JMS provider for application-managed authentication.

This property provides a list of the J2C authentication data entry aliases that have been defined to WAS. You can select a data entry alias to be used to authenticate the creation of a new connection to the JMS provider.

If you have enabled global security for WAS, select the alias that specifies the user ID and password used to authenticate the creation of a new connection to the JMS provider. The use of this alias depends on the resource authentication (res-auth) setting declared in the connection factory resource reference of an application component's deployment descriptors.

Note that User IDs longer than 12 characters cannot be used for authentication with the embedded WebSphere JMS provider. For example, the default Windows NT user ID, Administrator, is not valid for use with embedded WebSphere messaging, because it contains 13 characters. Therefore, an authentication alias for a WebSphere JMS provider connection factory must specify a user ID no longer than 12 characters.

Container-managed Authentication Alias This alias specifies a user ID and password to be used to authenticate connection to a JMS provider for container-managed authentication.

This property provides a list of the J2C authentication data entry aliases that have been defined to WAS. You can select a data entry alias to be used to authenticate the creation of a new connection to the JMS provider.

If you have enabled global security for WAS, select the alias that specifies the user ID and password used to authenticate the creation of a new connection to the JMS provider. The use of this alias depends on the resource authentication (res-auth) setting declared in the connection factory resource reference of an application component's deployment descriptors.

Note that User IDs longer than 12 characters cannot be used for authentication with the embedded WebSphere JMS provider. For example, the default Windows NT user ID, Administrator, is not valid for use with embedded WebSphere messaging, because it contains 13 characters. Therefore, an authentication alias for a WebSphere JMS provider connection factory must specify a user ID no longer than 12 characters.

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

Data type String
Default Null
Range A valid WebSphere MQ queue manager name, as 1 through 48 ASCII characters

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

Data type String
Default Null
Range A valid TCP/IP hostname

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
Default Null
Range A valid TCP/IP port number, configured on the WebSphere MQ queue manager.

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

Data type String
Default Null
Range 1 through 20 ASCII characters

Transport type Specifies whether the WebSphere MQ client connection or JNI bindings are used for connection to the WebSphere MQ queue manager. The external JMS provider controls the communication protocols between JMS clients and JMS servers. Tune the transport type when you are using non-ASF nonpersistent, non-durable, non-transactional messaging or when you want to satisfy security issues and the client is local to the queue manager node.

Data type Enum
Units Not applicable
Default BINDINGS
Range

BINDINGS JNI bindings are used to connect to the queue manager. BINDINGS is a shared memory protocol and can only be used when the queue manager is on the same node as the JMS client and comes at some security risks that should be addressed through the use of EJB roles.

CLIENT WebSphere MQ client connection is used to connect to the queue manager. CLIENT is a typical TCP-based protocol.

DIRECT For WebSphere MQ Event Broker using DIRECT mode. DIRECT is a lightweight sockets protocol used in non-transactional, non-durable and non-persistent Publish/Subscribe messaging. DIRECT works only for clients and message-driven beans using the non-ASF protocol.
Recommended DIRECT is the fastest transport type and should be used where possible. Use BINDINGS when you want to satisfy additional security tasks and the queue manager is local to the JMS client. QUEUED is fallback for all other cases.

Note that WebSphere MQ 5.3 before CSD2 with the DIRECT setting can lose messages when used with message-driven beans and under load. This also happens with client-side based applications unless the broker's maxClientQueueSize is set to 0. Set this to 0 with the command #wempschangeproperties WAS_nodeName_server -e default -o DynamicSubscriptionEngine -n maxClientQueueSize -v 0 -x executionGroupUUID, where executionGroupUUID can be found by starting the broker and looking in the Event Log/Applications for event 2201. This value is usually ffffffff-0000-0000-000000000000.

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

The name of the broker's control queue. Publisher and subscriber applications, and other brokers, send all command messages (except publications and requests to delete publications) to this queue.

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

Broker queue manager The name of the WebSphere MQ queue manager that provides the publish/subscribe message broker.

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

Broker publication queue The name of the broker's 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
Default Null
Range 1 through 48 ASCII characters

Broker subscription queue The name of the broker's queue from which non-durable subscription messages are retrieved

The name of the broker's queue from which non-durable 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
Default Null
Range 1 through 48 ASCII characters

Broker CC subscription queue The name of the broker's queue from which non-durable subscription messages are retrieved for a ConnectionConsumer. This property applies only for use of the Web container.

The name of the broker's queue from which non-durable subscription messages are retrieved for a ConnectionConsumer. This property applies only for use of the Web container.

Data type String
Units En_US ASCII characters
Default Null
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 message broker products

Data type Enum
Units Not applicable
Default Advanced
Range

Advanced The message broker is provided by newer versions of WebSphere message broker products, such as WebsSphere MQ Integrator and EventBroker.

Basic The message broker is provided by the WebSphere MQ MA0C SupportPac (MQSeries - Publish/Subscribe) or MQSI working in MA0C compatibility mode.

Model queue definition The name of the model queue definition that the broker can use to create dynamic queues for non-default streams if the stream queue does not already exist

The name of the model queue definition that the broker can use to create dynamic queues to receive publications for streams other than the default stream. This is only used if the stream queue does not already exist. If this model queue definition does not exist, all stream queues must be defined by the administrator.

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

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

This coded character set identifier (CCSID) must be one of the CCSIDs supported by WebSphere MQ.

Data type String
Units Integer
Default Null
Range 1 through 65535

For more information about supported CCSIDs, and about converting between message data from one coded character set to another, see WebSphere MQ System Administration and the WebSphere MQ Application Programming Reference books. These are available from the WebSphere MQ messaging multiplatform and platform-specific books Web pages; for example, at    http://www-3.ibm.com/software/ts/mqseries/library/manualsa/manuals/platspecific.html , the    IBM Publications Center , or from the WebSphere MQ collection kit, SK2T-0730.

Clone Support Select this checkbox to enable clone support to allow the same durable subscription across topic clones.

Data type Enum
Units Not applicable
Default Cleared
Range

Selected Clone support is enabled.

Cleared Clone support is disabled.

If you select this property, also specify a value for the Client ID property.

Client ID The JMS client identifier used for connections to the queue manager.

Data type String
Range A valid JMS client ID, as ASCII characters

XA Enabled Specifies whether the connection factory is for XA or non-XA coordination of messages and controls if the appserver uses XA QCF/TCF. Enable XA if multiple resources are not used in the same transaction.

If you set this property to NON_XA, the JMS session is still enlisted in a transaction, but uses the resource manager local transaction calls (session.commit and session.rollback) instead of XA calls. This can lead to an improvement in performance. However, this means that only a single resource can be enlisted in a transaction in WAS.

In WBI Server Foundation the last participant support enables you to enlist one non-XA resource with other XA-capable resources.

For a WebSphere Topic Connection Factory with the Port property set to DIRECT this property does not apply, and always takes the value NON_XA.

Data type Enum
Units Not applicable
Default XA enabled
Range

XA The connection factory is for XA-coordination of messages

NON_XA The connection factory is for non-XA coordination of messages
Recommended Do not enable XA when the message queue or topic received is the only resource in the transaction. Enable XA when other resources, including other queues or topics, are involved.

Connection pool Specifies an optional set of connection pool settings.

Connection pool properties are common to all J2C connectors.

The appserver 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. See the following table for details.

Session pool An optional set of session pool settings.

This link provides a panel of optional connection pool properties, common to all J2C connectors.

The appserver 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.

Custom properties An optional set of name and value pairs for custom properties passed to WebSphere MQ.

Use the Custom properties page to define the following WebSphere MQ properties. These properties apply only if you set the property Transport type=CLIENT.