Properties of ConnectionFactory
An overview of the properties of the ConnectionFactory object, with links to more detailed reference information.
| Name of property | Description |
|---|---|
| XMSC_ASYNC_EXCEPTIONS | This property determines whether XMS informs an ExceptionListener only when a connection is broken, or when any exception occurs asynchronously to an XMS API call. This property applies to all Connections created from this ConnectionFactory that have an ExceptionListener registered. |
| XMSC_CLIENT_ID | The client identifier for a connection. |
| XMSC_CONNECTION_TYPE | The type of messaging server to which an application connects. |
| XMSC_PASSWORD | A password that can be used to authenticate the application when it attempts to connect to a messaging server. |
| XMSC_RTT_BROKER_PING_INTERVAL | The time interval, in milliseconds, after which XMS .NET checks the connection to a Real Time messaging server to detect any activity. |
| XMSC_RTT_CONNECTION_PROTOCOL | The communications protocol used for a real-time connection to a broker. |
| XMSC_RTT_HOST_NAME | The host name or IP address of the system on which a broker runs. |
| XMSC_RTT_LOCAL_ADDRESS | The host name or IP address of the local network interface to be used for a real-time connection to a broker. |
| XMSC_RTT_MULTICAST | The multicast setting for a connection factory or destination. |
| XMSC_RTT_PORT | The number of the port on which a broker listens for incoming requests. |
| XMSC_USERID | A user identifier that can be used to authenticate the application when it attempts to connect to a messaging server. |
| XMSC_WMQ_BROKER_CONTROLQ | The name of the
control queue used by a broker. Note: This
property can be used with Version 2.0 of IBM® Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere® MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_BROKER_PUBQ | The name of the queue
monitored by a broker where applications send messages that they publish. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_BROKER_QMGR | The name of the queue
manager to which a broker is connected. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_BROKER_SUBQ | The name of the subscriber
queue for a nondurable message consumer. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_BROKER_VERSION | The type of broker
used by the application for a connection or for the destination. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_CCDTURL | A Uniform Resource Locator (URL) that identifies the name and location of the file that contains the client channel definition table and also specifies how the file can be accessed. |
| XMSC_WMQ_CHANNEL | The name of the channel to be used for a connection. |
| XMSC_WMQ_CLIENT_RECONNECT_OPTIONS | This property specifies the client reconnect options for new connections created by this factory |
| XMSC_WMQ_CLIENT_RECONNECT_TIMEOUT | This property specifies the duration of time, in seconds, that a client connection attempts to reconnect. |
| XMSC_WMQ_CONNECTION_MODE | The mode by which an application connects to a queue manager. |
| XMSC_WMQ_CONNECTION_NAME_LIST | This property specifies the hosts to which the client attempts to reconnect to after its connection are broken. |
| XMSC_WMQ_FAIL_IF_QUIESCE | Whether calls to certain methods fail if the queue manager to which the application is connected is in a quiescing state. |
| XMSC_WMQ_HOST_NAME | The host name or IP address of the system on which a queue manager runs. |
| XMSC_WMQ_LOCAL_ADDRESS | For a connection to a queue manager, this property specifies the local network interface to be used, or the local port or range of local ports to be used, or both. |
| XMSC_WMQ_MESSAGE_SELECTION | Determines whether
message selection is done by the XMS client or by the
broker. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_MSG_BATCH_SIZE | The maximum number
of messages to be retrieved from a queue in one batch when using asynchronous
message delivery. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_POLLING_INTERVAL | If each message
listener within a session has no suitable message on its queue, this
value is the maximum interval, in milliseconds, that elapses before
each message listener tries again to get a message from its queue. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_PROVIDER_VERSION | The version, release, modification level and fix pack of the queue manager to which the application intends to connect. |
| XMSC_WMQ_PORT | The number of the port on which a queue manager listens for incoming requests. |
| XMSC_WMQ_PUB_ACK_INTERVAL | The number of messages
published by a publisher before the XMS client requests
an acknowledgement from the broker. Note: This
property can be used with Version 2.0 of IBM Message Service Client for .NET but has no effect for an application
connected to a IBM WebSphere MQ 7.0 queue manager
unless the XMSC_WMQ_PROVIDER_VERSION property of the connection factory
is set to a version number less than 7.
|
| XMSC_WMQ_PUT_ASYNC_ALLOWED | This property determines whether message producers are allowed to use asynchronous puts to send messages to this destination. |
| XMSC_WMQ_QMGR_CCSID | The identifier (CCSID) of the coded character set, or code page, in which fields of character data defined in the Message Queue Interface (MQI) are exchanged between the XMS client and the WebSphere MQ client. |
| XMSC_WMQ_QUEUE_MANAGER | The name of the queue manager to connect to. |
| XMSC_WMQ_RECEIVE_EXIT | Identifies a channel receive exit to be run. |
| XMSC_WMQ_RECEIVE_EXIT_INIT | The user data that is passed to a channel receive exit when it is called. |
| XMSC_WMQ_SECURITY_EXIT | Identifies a channel security exit. |
| XMSC_WMQ_SECURITY_EXIT_INIT | The user data that is passed to a channel security exit when it is called. |
| XMSC_WMQ_SEND_CHECK_COUNT | The number of send calls to allow between checking for asynchronous put errors, within a single non-transacted XMS session. |
| XMSC_WMQ_SEND_EXIT | Identifies a channel send exit. |
| XMSC_WMQ_SEND_EXIT_INIT | The user data that is passed to channel send exits when they are called. |
| XMSC_WMQ_SHARE_CONV_ALLOWED | Whether a client connection can share its socket with other top-level XMS connections from the same process to the same queue manager, if the channel definitions match. This property is provided to allow complete isolation of Connections in separate sockets if required for application development, maintenance, or operational reasons. |
| XMSC_WMQ_SSL_CERT_STORES | The locations of the servers that hold the certificate revocation lists (CRLs) to be used on an SSL connection to a queue manager. |
| XMSC_WMQ_SSL_CIPHER_SPEC | The name of the CipherSpec to be used on a secure connection to a queue manager. |
| XMSC_WMQ_SSL_CIPHER_SUITE | The name of the CipherSuite to be used on an SSL or TLS connection to a queue manager. The protocol used in negotiating the secure connection depends on the specified CipherSuite. |
| XMSC_WMQ_SSL_CRYPTO_HW | Configuration details for the cryptographic hardware connected to the client system. |
| XMSC_WMQ_SSL_FIPS_REQUIRED | The value of this property determines whether an application can or cannot use non-FIPS compliant cipher suites. If this property is set to true, only FIPS algorithms are used for the client-server connection. |
| XMSC_WMQ_SSL_KEY_REPOSITORY | The location of the key database file in which keys and certificates are stored. |
| XMSC_WMQ_SSL_KEY_RESETCOUNT | The KeyResetCount represents the total number of unencrypted bytes sent and received within an SSL conversation before the secret key is renegotiated. |
| XMSC_WMQ_SSL_PEER_NAME | The peer name to be used on an SSL connection to a queue manager. |
| XMSC_WMQ_SYNCPOINT_ALL_GETS | Whether all messages must be retrieved from queues within sync point control. |
| XMSC_WMQ_TARGET_CLIENT | |
| XMSC_WMQ_TEMP_Q_PREFIX | The prefix used to form the name of the WebSphere MQ dynamic queue that is created when the application creates an XMS temporary queue. |
| XMSC_WMQ_TEMP_TOPIC_PREFIX | When creating temporary topics, XMS generates a topic string of the form "TEMP/TEMPTOPICPREFIX/unique_id", or if this property contains the default value, then this string, "TEMP/unique_id", is generated. Specifying a non-empty value allows specific model queues to be defined for creating the managed queues for subscribers to temporary topics created under this connection. |
| XMSC_WMQ_TEMPORARY_MODEL | The name of the WebSphere MQ model queue from which a dynamic queue is created when the application creates an XMS temporary queue. |
| XMSC_WPM_BUS_NAME | For a connection factory, the name of the service integration bus that the application connects to or, for a destination, the name of the service integration bus in which the destination exists. |
| XMSC_WPM_CONNECTION_PROXIMITY | The connection proximity setting for the connection. |
| XMSC_WPM_DUR_SUB_HOME | The name of the messaging engine where all durable subscriptions for a connection or a destination are managed. |
| XMSC_WPM_LOCAL_ADDRESS | For a connection to a service integration bus, this property specifies the local network interface to be used, or the local port or range of local ports to be used, or both. |
| XMSC_WPM_NON_PERSISTENT_MAP | The reliability level of nonpersistent messages that are sent using the connection. |
| XMSC_WPM_PERSISTENT_MAP | The reliability level of persistent messages that are sent using the connection. |
| XMSC_WPM_PROVIDER_ENDPOINTS | A sequence of one or more endpoint addresses of bootstrap servers. |
| XMSC_WPM_TARGET_GROUP | The name of a target group of messaging engines. |
| XMSC_WPM_TARGET_SIGNIFICANCE | The significance of the target group of messaging engines. |
| XMSC_WPM_TARGET_TRANSPORT_CHAIN | The name of the inbound transport chain that the application must use to connect to a messaging engine. |
| XMSC_WPM_TARGET_TYPE | The type of the target group of messaging engines. |
| XMSC_WPM_TEMP_Q_PREFIX | The prefix used to form the name of the temporary queue that is created in the service integration bus when the application creates an XMS temporary queue. |
| XMSC_WPM_TEMP_TOPIC_PREFIX | The prefix used to form the name of a temporary topic that is created by the application. |