jmsTopicConnectionFactory - JMS Topic Connection Factory (jmsTopicConnectionFactory)

Defines a JMS topic connection factory configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
connectionManagerRefA reference to top level connectionManager element (string).Connection manager for a connection factory.
containerAuthDataRefA reference to top level authData element (string).Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
jndiNamestringJNDI name for a resource.
recoveryAuthDataRefA reference to top level authData element (string).Authentication data for transaction recovery.

connectionManager

Connection manager for a connection factory.

NameTypeDefaultDescription
agedTimeoutA period of time with second precision-1Amount of time before a connection can be discarded by pool maintenance. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
connectionTimeoutA period of time with second precision30sAmount of time after which a connection request times out. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxIdleTimeA period of time with second precision30mAmount of time a connection can be unused or idle until it can be discarded during pool maintenance, if doing so does not reduce the pool below the minimum size. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxPoolSizeint
Min: 0
50Maximum number of physical connections for a pool. A value of 0 means unlimited.
minPoolSizeint
Min: 0
Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum.
purgePolicy
  • ValidateAllConnections
  • FailingConnectionOnly
  • EntirePool
EntirePoolSpecifies which connections to destroy when a stale connection is detected in a pool.
ValidateAllConnections
When a stale connection is detected, connections are tested and those found to be bad are closed.
FailingConnectionOnly
When a stale connection is detected, only the connection which was found to be bad is closed.
EntirePool
When a stale connection is detected, all connections in the pool are marked stale, and when no longer in use, are closed.
reapTimeA period of time with second precision3mAmount of time between runs of the pool maintenance thread. A value of -1 disables pool maintenance. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxConnectionsPerThreadint
Min: 0
Limits the number of open connections on each thread.
numConnectionsPerThreadLocalint
Min: 0
Caches the specified number of connections for each thread.
enableSharingForDirectLookupsbooleantrueIf set to true, connections are shared. If set to false, connections are unshared.

containerAuthData

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

recoveryAuthData

Authentication data for transaction recovery.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

properties.wasJms

A JMS topic connection factory is used to create connections to the associated JMS provider of JMS destinations, for publish/subscribe messaging.

NameTypeDefaultDescription
busNamestringdefaultBusThe name of a bus when connecting to the service integration bus in a full profile server.
clientIDstringclientIDThe JMS client identifier needed for durable(and for shared non-durable) topic subscriptions on all connections. This identifier is required if the application is doing durable(and for shared non-durable) publish/subscribe messaging.
durableSubscriptionHomestringdefaultMEDurable subscription home defines ME name to which connection needs to be established.
nonPersistentMapping
  • BestEffortNonPersistent
  • ReliableNonPersistent
  • ExpressNonPersistent
ExpressNonPersistentThe reliability applied to Non-persistent JMS messages sent using this connection factory.
BestEffortNonPersistent
BestEffortNonPersistent
ReliableNonPersistent
ReliableNonPersistent
ExpressNonPersistent
ExpressNonPersistent
persistentMapping
  • AssuredPersistent
  • ReliablePersistent
ReliablePersistentThe reliability applied to persistent JMS messages sent using this connection factory.
AssuredPersistent
AssuredPersistent
ReliablePersistent
ReliablePersistent
readAhead
  • AlwaysOff
  • Default
  • AlwaysOn
DefaultRead ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.
AlwaysOff
AlwaysOff
Default
Default
AlwaysOn
AlwaysOn
temporaryTopicNamePrefixstringtempThe prefix of up to twelve characters used for the temporary topics created by applications that use this topic connection factory.
passwordReversably encoded password (string)It is recommended to use a container managed authentication alias instead of configuring this property.
remoteServerAddressstringThe remote server address that has triplets separated by a comma, with the syntax hostName:portNumber:chainName, used to connect to a bootstrap server. For example, Merlin:7276:BootstrapBasicMessaging. If hostName is not specified, the default is localhost. If portNumber is not specified, the default is 7276. If chainName is not specified, the default is BootstrapBasicMessaging. Refer to the information center for more information.
shareDurableSubscriptionstringControls whether or not durable subscription can be shared across connections.
targetTransportChainstringTransport chains specify the communication protocols that can be used to communicate with the service integration bus in a full profiles server.
userNamestringIt is recommended to use a container managed authentication alias instead of configuring this property.

properties.wmqJms

WebSphere MQ JMS topic connection factory

NameTypeDefaultDescription
portint
Min: 1
1414The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
providerVersion
  • 7
  • 6
  • unspecified
unspecifiedThe version, release, modification level and fix pack of the queue manager to which the application intends to connect.
7
7
6
6
unspecified
unspecified
shareConvAllowedbooleantrueWhether a client connection can share its socket with other top-level JMS connections from the same process to the same queue manager, if the channel definitions match
targetClientMatchingbooleantrueWhether a reply message, sent to the queue identified by the JMSReplyTo header field of an incoming message, has an MQRFH2 header only if the incoming message has an MQRFH2 header.
transportType
  • CLIENT
  • BINDINGS
CLIENTWhether a connection to a queue manager uses client mode or bindings mode.
CLIENT
CLIENT
BINDINGS
BINDINGS
CCSIDint
Min: 1
819The coded character set identifier for a connection.
failIfQuiescebooleantrueWhether calls to certain methods fail if the queue manager is in a quiescing state.
headerCompression
  • SYSTEM
  • NONE
NONEA list of the techniques that can be used for compressing header data on a connection
SYSTEM
SYSTEM
NONE
NONE
messageCompression
  • RLE
  • NONE
NONEA list of the techniques that can be used for compressing message data on a connection.
RLE
RLE
NONE
NONE
rescanIntervalA period of time with millisecond precision5sWhen a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, WebSphere MQ classes for JMS searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
sslResetCountint
Min: 0

Max: 999999999
0The total number of bytes sent and received by an SSL connection before the secret keys used by SSL are renegotiated.
cleanupLevel
  • SAFE
  • FORCE
  • NONDUR
  • NONE
  • STRONG
SAFEThe cleanup level for a broker-based subscription store.
SAFE
SAFE
FORCE
FORCE
NONDUR
NONDUR
NONE
NONE
STRONG
STRONG
cloneSupport
  • ENABLED
  • DISABLED
DISABLEDWhether two or more instances of the same durable topic subscriber can run simultaneously.
ENABLED
ENABLED
DISABLED
DISABLED
messageSelection
  • CLIENT
  • BROKER
CLIENTDetermines whether message selection is done by WebSphere MQ classes for JMS or by the broker.
CLIENT
CLIENT
BROKER
BROKER
pubAckIntervalint
Min: 0
25The number of messages published by a publisher before WebSphere MQ classes for JMS requests an acknowledgment from the broker
sparseSubscriptionsbooleanfalseControls the message retrieval policy of a TopicSubscriber object.
statusRefreshIntervalA period of time with millisecond precision1mThe interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subscription store has the value QUEUE. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
subscriptionStore
  • MIGRATE
  • BROKER
  • QUEUE
BROKERDetermines where WebSphere MQ classes for JMS stores persistent data about active subscriptions.
MIGRATE
MIGRATE
BROKER
BROKER
QUEUE
QUEUE
wildcardFormat
  • CHAR
  • TOPIC
TOPICWhich version of wildcard syntax is to be used.
CHAR
CHAR
TOPIC
TOPIC
applicationNamestringThe name by which an application is registered with the queue manager.
ccdtURLstringA URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed.
channelstringThe name of the MQI channel to use.
clientIdstringThe client identifier for a connection
connectionNameListstringA list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties.
hostNamestringThe host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
passwordReversably encoded password (string)The default password to use when creating a connection to the queue manager. (It is recommended to use a container managed authentication alias instead of configuring this property)
queueManagerstringThe name of the queue manager to connect to
tempTopicPrefixstringWhen creating temporary topics, JMS generates a topic string of the form TEMP/TEMPTOPICPREFIX/unique_id, or if this property is left with the default value, just TEMP/unique_id. Specifying a non-empty TEMPTOPICPREFIX allows specific model queues to be defined for creating the managed queues for subscribers to temporary topics created under this connection.
userNamestringThe default user name to use when creating a connection to a queue manager. (It is recommended to use a container managed authentication alias instead of configuring this property)
localAddressstringFor a connection to a queue manager, this property specifies either or both of the following, (1) The local network interface to be used, (2) The local port, or range of local ports, to be used
pollingIntervalA period of time with millisecond precisionIf 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. If it frequently happens that no suitable message is available for any of the message listeners in a session, consider increasing the value of this property. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
sendCheckCountint
Min: 0
The number of send calls to allow between checking for asynchronous put errors, within a single non-transacted JMS session.
sslCertStoresstringThe Lightweight Directory Access Protocol (LDAP) servers that hold certificate revocation lists (CRLs) for use on an SSL connection.
sslCipherSuitestringThe CipherSuite to use for an SSL connection.
sslFipsRequiredbooleanWhether an SSL connection must use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS).
sslPeerNamestringFor an SSL connection, a template that is used to check the distinguished name in the digital certificate provided by the queue manager.
brokerCCSubQueuestringThe name of the queue from which a connection consumer receives nondurable subscription messages
brokerControlQueuestringThe name of the broker control queue
brokerPubQueuestringThe name of the queue where published messages are sent (the stream queue).
brokerQueueManagerstringThe name of the queue manager on which the broker is running
brokerSubQueuestringThe name of the queue from which a nondurable message consumer receives messages
brokerVersion
  • 2
  • 1
The version of the broker being used
2
2
1
1
cleanupIntervalA period of time with millisecond precisionThe interval, in milliseconds, between background runs of the publish/subscribe cleanup utility. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
receiveExitstringIdentifies a channel receive exit program, or a sequence of receive exit programs to be run in succession
receiveExitInitstringThe user data that is passed to channel receive exit programs when they are called
securityExitstringIdentifies a channel security exit program
securityExitInitstringThe user data that is passed to a channel security exit program when it is called
sendExitstringIdentifies a channel send exit program, or a sequence of send exit programs to be run in succession.
sendExitInitstringThe user data that is passed to channel send exit programs when they are called.
arbitraryPropertiesstringAbility to specify properties not defined elsewhere