Broker 10.5 | webMethods Broker Documentation | webMethods Broker Messaging Programmer's Guide | webMethods Messaging Administration | JMSAdmin Command Reference | JMSAdmin Command Descriptions | Bind ClusterTopicConnectionFactory
 
Bind ClusterTopicConnectionFactory
Adds a Cluster Topic ConnectionFactory definition into a JNDI context.
Syntax
bind { cl_tcf | ClusterTopicConnectionFactory }lookup-name
[ withclusterName=cluster-name clusterBrokers=
(broker-name@broker-server:port)
+
[ clusterRefreshInterval=cluster-refresh-interval ]
[ clusterPolicy=cluster-policy-name ]
[ weights=(weight-per-broker)+ ]
[ multiSendCount=broker-count-for-multisend-policy ]
[ includeAllBrokers={ true | false }]
[ clientId=client-id ]
[ application=application-name ]
[ group=client-group-name ]
[ sslKeystore=filename ]
[ sslPassword=password ]
[ sslTruststore=filename ]
[ sslEncrypted={ true | false }]
[ useXA={ true | false }]
[ marshallInClassName=class-name ]
[ marshallOutClassName=class-name ] ]
The command syntax has these parts:
Part
Description
lookup-name
Required. The name used to look up this connection factory in the JNDI directory.
clusterName
Required. The name of the cluster containing the Brokers. During run time, If includeAllBrokers is set to true, the name of the cluster and the first Broker in the cluster is used to identify the remaining Brokers in the cluster.
When includeAllBrokers is set to true, set the value of clusterName correctly to retrieve all the other Brokers in the cluster.
clusterBrokers
Required.List of Brokers in the cluster that will be part of this connection factory. A cluster Broker is specified in the form of broker-name@broker-server:port. The list of Brokers in the cluster is specified by separating the cluster Brokers with a comma (,).
For example, set the value of clusterBrokers as following:
clusterBrokers=broker_01@<hostname>:<port>,
broker_02@<hostname>:<port>
or use variables to specify the list of Brokers:
set $brkr_set=broker_01@<hostname>:<port>,
broker_02@<hostname>:<port>clusterBrokers=$brkr_set
clusterRefreshInterval
Optional.The cluster refresh interval in minutes. JMS client applications can use this interval to refresh the cluster connection factory, and choose to reconnect if the connection factory has changed. The webMethods API for JMS will not automatically refresh the connection factories or Broker connections. The value of this property must be an integer greater than 0.
The default value is 1440.
clusterPolicy
Optional.The name of the cluster routing policy. Specify any of the following policies:
*ROUND_ROBIN (the default value)
*STICKY
*RANDOM
*WEIGHTED_ROUND_ROBIN
*MULTISEND_GUARANTEED
*MULTISEND_BEST_EFFORT
Note:MULTISEND_GUARANTEED cluster policy is applicable only to XA connection factories. MULTISEND_BEST_EFFORT policy does not work with XA connection factory.
weights
Optional. A comma separated list of weights of each Broker in the cluster governed by WEIGHTED_ROUND_ROBIN policy. Specify the weight of each Broker in the same order as specified in the clusterBrokers property. The weights must be greater than 0.
For example, weights=10,20.
If you do not specify a weight for a Broker, a weight of 1 is set for that Broker.
Note:
Set this property only when clusterPolicy property value is set to WEIGHTED_ROUND_ROBIN policy.
multiSendCount
Optional. The number of Brokers in the cluster governed by MULTISEND_GUARANTEED cluster policy. The value of this property must be greater than 0 and less than the number of Brokers in the cluster.
Note:
Set this property only when clusterPolicy property value is set to MULTISEND_GUARANTEED policy.
includeAllBrokers
Optional. Whether to include all the Brokers in the cluster with this connection factory.
*If set to true, all the Brokers in the cluster are included in this connection factory. The value of clusterName property and the first Broker in the cluster is used to retrieve all the other Brokers in the cluster.
*If set to false, all the Brokers are not included in this connection factory.
The default value is false.
clientID
Optional. The base client ID for connections created by this factory.
*If you specify a client ID, it must be unique. This ID is assigned to all the connections to the Brokers in the cluster.
*If you do not specify a client ID, the connection factory assigns a unique ID when a connection is established.
application
Optional. The name of the application stored as part of the application's Broker client state. The application is displayed by JMSAdmin.
group
Optional. The client group name that clients created from this connection factory will use. Note that the bind command does not create the client group; you must create a client group explicitly using the create group command. The default client-group-name is JMSClient.
sslKeystore
Optional. The fully qualified path of the file containing the SSL certificate that JMSAdmin will use on SSL connections made from this connection factory.
sslPassword
Optional. The password for the keystore file that JMSAdmin is to use when connecting to the Broker using SSL.
sslTruststore
Optional. The file that holds the trusted root (CA public key) that JMSAdmin will use to connect to an SSL-enabled Broker.
sslEncrypted
Optional. Whether traffic to the Broker on connections made from this connection factory will be encrypted.
*If set to true, all traffic to the Broker on this connection will be encrypted.
*If set to false, the connection will be authenticated but no data will be encrypted.
The default value is false.
useXA
Optional. Whether XA transactions are allowed with this cluster topic connection factory. The default value is true, which means XA transactions are allowed. If you are not using the specified cluster topic connection factory with an application server, specifying false saves some of the overhead associated with support for cluster XA topic connection factories.
This parameter is for JMS only. If the connection factory is for a C# client, this parameter is ignored.
marshalInClassName
Optional. Class name of the inbound marshaller (JMS clients only).
marshalOutClassName
Optional. Class name of the outbound marshaller (JMS clients only).
Remarks
You can only use the marshalInClassName and marshalOutClassName parameters when implementing the marshalling feature when you use webMethods Broker as a JMS provider. For more information, see JMS Marshalling.
Example
bind ClusterTopicConnectionFactory TEST_CONNECTION_FACTORY with
clusterName=cluster_01
clusterBrokers=$brkr_set
clusterPolicy=ROUND_ROBIN
clusterRefreshInterval=640
useXA=true

show TEST_CONNECTION_FACTORY

TEST_CONNECTION_FACTORY : com.webmethods.jms.impl.WmXATopicConnectionFactoryImpl
clusterName: cluster_01
clusterBrokers: broker_01@hostname:port,broker_02@hostname:port
includeAllBrokers: false
clusterRefreshInterval: 640
clusterPolicy: ROUND_ROBIN
application: JMS
clientGroup: JMSClient
clientId: <not specified>
sslKeystore: <not specified>
sslTruststore: <not specified>
sslKeystoreType: <not specified>
sslTruststoreType: <not specified>
sslEncrypted: false
useXA: true
marshalInClassName: <not specified>
marshalOutClassName: <not specified>
Related Commands
Modify ClusterTopicConnectionFactory