WebSphere WebSphere Business Integration Message Service Clients for C/C++ Version 1.2.7 and .NET Version 1.2.6 Operating Systems: AIX, Linux, Solaris, Windows

Properties of ConnectionFactory

An overview of the properties of the ConnectionFactory object, with links to more detailed reference information.

Table 1. Properties of ConnectionFactory
Name of property Description
XMSC_CLIENT_CCSID The identifier (CCSID) of the coded character set, or code page, used by a connection, session, message producer, or message consumer.
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_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 resides.
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.
XMSC_WMQ_BROKER_PUBQ The name of the queue monitored by a broker where applications send messages that they publish.
XMSC_WMQ_BROKER_QMGR The name of the queue manager to which a broker is connected.
XMSC_WMQ_BROKER_SUBQ The name of the subscriber queue for a nondurable message consumer.
XMSC_WMQ_BROKER_VERSION The type of broker used by the application for a connection or for the destination.
XMSC_WMQ_CHANNEL The name of the channel to be used for a connection.
XMSC_WMQ_CONNECTION_MODE The mode by which an application connects to a queue manager.
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 resides.
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.
XMSC_WMQ_MSG_BATCH_SIZE The maximum number of messages to be retrieved from a queue in one batch when using asynchronous message delivery.
XMSC_WMQ_POLLING_INTERVAL If each message listener within a session has no suitable message on its queue, this is the maximum interval, in milliseconds, that elapses before each message listener tries again to get a message from its queue.
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.
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, or a sequence of channel receive exits, to be run in succession.
XMSC_WMQ_RECEIVE_EXIT_INIT The user data that is passed to channel receive exits when they are 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_EXIT Identifies a channel send exit, or a sequence of channel send exits, to be run in succession.
XMSC_WMQ_SEND_EXIT_INIT The user data that is passed to channel send exits when they are called.
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 cipher spec 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 syncpoint control.
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_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_SSL_CIPHER_SUITE The name of the CipherSuite to be used on an SSL or TLS connection to a WebSphere service integration bus messaging engine. The protocol used in negotiating the secure connection depends on the specified CipherSuite.
XMSC_WPM_SSL_KEY_REPOSITORY A path to the file that is the keyring file containing the public or private keys to be used in the secure connection.
XMSC_WPM_SSL_KEYRING_LABEL The certificate to be used when authenticating with the server.
XMSC_WPM_SSL_KEYRING_PW The password for the keyring file.
XMSC_WPM_SSL_KEYRING_STASH_FILE The name of a binary file containing the password of the key repository file.
XMSC_WPM_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_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.
Related concepts
ConnectionFactories and Connection objects
Connection to a WebSphere service integration bus
Secure connections to a WebSphere MQ queue manager
Secure connections to a WebSphere service integration bus messaging engine
Property mapping for administered objects
Related tasks
Creating administered objects
Related reference
Required properties for administered ConnectionFactory objects

Reference topic

Terms of Use | Rate this page

Last updated: 18 Jun 2008

© Copyright IBM Corporation 2005, 2008. All Rights Reserved.