java.lang.Object | +----com.ibm.mq.jms.MQConnectionFactory
MQConnectionFactory is the WebSphere MQ implementation of ConnectionFactory. A ConnectionFactory encapsulates a set of connection configuration parameters that has been defined by an administrator. A client uses it to create a Connection with a JMS provider.
public MQConnectionFactory();
This is the default constructor. It will create an MQConnectionFactory with all properties set to their default values.
public Connection createConnection() throws JMSException;
Creates a connection with the default user identity. The connection is created in stopped mode. No messages are delivered until Connection.start() is explicitly called.
public Connection createConnection(String userName, String password) throws JMSException;
Creates a connection with the specified user identity. The connection is created in stopped mode. No messages are delivered until Connection.start() is explicitly called.
public String getBrokerCCSubQueue() throws JMSException;
Gets the broker's queue name for nondurable connection consumers.
public String getBrokerControlQueue() throws JMSException;
Gets the broker's control queue name.
public String getBrokerPubQueue() throws JMSException;
Gets the broker's publish queue name.
public String getBrokerQueueManager() throws JMSException;
Gets the name of the broker's queue manager.
public String getBrokerSubQueue() throws JMSException;
Gets the broker's queue name for nondurable subscribers.
public int getBrokerVersion() throws JMSException;
Gets the version number of the broker.
public URL getCCDTURL();
Gets the URL for the client channel definition table.
public int getCCSID();
Gets the character set of the queue manager.
public String getChannel();
Gets the name of the channel that was used.
public long getCleanupInterval() throws JMSException;
Gets the clean up interval.
public int getCleanupLevel() throws JMSException;
Gets the clean up level.
public String getClientId();
Deprecated
use the getClientID() method instead.
public String getClientID();
Gets the client ID.
Note that this method always throws an IllegalStateException when you make a direct connection to a broker.
public int getCloneSupport() throws JMSException;
Indicates whether cloning is supported.
public byte[] getConnTag();
Gets the value of the queue manager connection tag. It is used by the queue manager to serialize access to the affected resources. This tag is only used when connecting to a z/OS queue manager. On other platforms it will have the value MQCT_NONE - its default value.
public String getDescription();
Gets the description.
public int getDirectAuth() throws JMSException;
Gets the type of direct authentication that is required.
public int getFailIfQuiesce();
Indicates the default behavior of applications accessing a quiescing queue manager.
public Collection getHdrCompList();
Gets the list of header compression techniques which has been set.
public String getHostName();
Gets the name of the host. This only applies for client connections or direct TCP/IP connections to WebSphere MQ.
public String getLocalAddress();
Gets the local address.
public boolean getMapNameStyle();
Allows compatibility style to be used for MapMessage element names.
public int getMessageRetention() throws JMSException;
Indicates what happens to unwanted messages.
public int getMessageSelection() throws JMSException;
Indicates whether the client or the broker performs message selection.
public int getMQConnectionOptions();
Gets the connection options.
public int getMsgBatchSize();
Gets the message batch size.
public Collection getMsgCompList();
Gets the list of message compression techniques that have been set.
public int getMulticast() throws JMSException;
Gets the value of the multicast attribute.
public boolean getOptimisticPublication() throws JMSException;
Indicates whether transactional publish/subscribe MessageProducers should return immediately from a send/publish call rather than wait until the message has completed delivery. If false, failure to deliver the message will only be reported when the message is committed.
public boolean getOutcomeNotification() throws JMSException;
Indicates whether the publish/subscribe MessageConsumers are informed of the outcome of acknowledge or commit calls after receiving messages.
public int getPollingInterval();
Gets the interval between scans of all receivers during asynchronous message delivery.
public int getPort();
Gets the port number. Applies to client connections or direct TCP/IP connection to a broker.
public int getProcessDuration() throws JMSException;
Indicates how promptly received messages are processed. While this alone does not make any difference, quickly processing messages is a prerequisite for viewing uncommitted messages.
public String getProxyHostName() throws JMSException;
Gets the proxy host name.
public int getProxyPort() throws JMSException;
Gets the port number of the proxy server.
public int getPubAckInterval() throws JMSException;
Gets the number of messages that can be published before requiring acknowledgement from the broker.
public String getQueueManager();
Gets the name of the queue manager.
public String getReceiveExit();
Gets the description of the receive exit.
public String getReceiveExitInit();
Gets the initialization string for the receive exit.
public int getReceiveIsolation() throws JMSException;
Indicates whether calls by MessageConsumers are isolated from other operations.
public Reference getReference() throws NamingException;
Creates a reference for this queue connection factory.
public int getRescanInterval();
Gets the interval between browse scans of a queue. The scan looks for messages that have not been returned by the previous browse scan.
public String getSecurityExit();
Gets the description of the security exit.
public String getSecurityExitInit();
Gets the initialization string for the security exit.
public String getSendExit();
Gets the description of the send exit.
public String getSendExitInit();
Gets the initialization string for the send exit.
public boolean getSparseSubscriptions() throws JMSException;
Gets the sparse subscriptions attribute. A sparse subscription is one that receives infrequent matching messages. If the attribute is true the application must be able to open the consumer queue for browsing messages.
public Collection getSSLCertStores() throws JMSException;
Gets the collection of CertStore objects.
public String getSSLCertStoresAsString() throws JMSException;
Gets the collection of CertStore objects as a String.
public String getSSLCipherSuite();
Gets the CipherSuite used for SSL encryption.
public boolean getSSLFipsRequired();
Indicates whether sslFips (FIPS) is required.
public String getSSLPeerName();
Gets the distinguished name pattern used to validate the queue manager.
public int getSSLResetCount();
Gets the SSL reset count.
public Object getSSLSocketFactory();
Gets the SSLSocketFactory used with SSL encryption.
public int getStatusRefreshInterval() throws JMSException;
Gets the status refresh interval.
public int getSubscriptionStore() throws JMSException;
Gets the SUBSTORE property.
public boolean getSyncpointAllGets();
Indicates how syncpoint is used for GET operations.
public boolean getTargetClientMatching();
is target client matching enabled.
public String getTemporaryModel() throws JMSException;
Gets the name of a model queue for creating temporary destinations.
public String getTempQPrefix() throws JMSException;
Gets the prefix used to form the name of a WebSphere MQ dynamic queue.
public int getTransportType();
Gets the transport type.
public boolean getUseConnectionPooling();
Indicates whether connection pooling has been selected.
public int getVersion();
Gets the version number.
public void setBrokerCCSubQueue(String queueName) throws JMSException;
Sets the name of the broker nondurable connection consumer subscriber queue.
public void setBrokerControlQueue(String queueName) throws JMSException;
Sets the name of the broker control queue.
public void setBrokerPubQueue(String queueName) throws JMSException;
Sets the name of the broker's publish queue. Note that if this is a user-defined queue, the broker must already be aware of this queue before connecting to the broker.
public void setBrokerQueueManager(String queueManagerName) throws JMSException;
Sets the name of the broker's queue manager.
public void setBrokerSubQueue(String queueName) throws JMSException;
Gets the name of the broker nondurable subscriber queue.
public void setBrokerVersion(int version) throws JMSException;
Sets the version of the broker.
public void setCCDTURL(URL url);
Sets the URL for the client channel definition table.
public void setCCSID(int ccsid) throws JMSException;
Sets the character set to be used when connecting to the queue manager.
public void setChannel(String channelName) throws JMSException;
Sets the name of the channel - applies to clients only.
public void setCleanupInterval(long interval) throws JMSException;
Sets the clean up interval.
public void setCleanupLevel(int level) throws JMSException;
Sets the clean up level.
public void setClientId(String id);
Deprecated
Use the setClientID() method instead.
public void setClientID(String id);
Sets the client ID.
Note that this method always throws an IllegalStateException when you make a direct connection to a broker.
public void setCloneSupport(int type) throws JMSException;
Selects whether cloning is supported.
public void setConnTag(byte[] cTag);
Sets the value of the queue manager connection tag. It is used by the queue manager to serialize access to the affected resources. This tag is only used when connecting to a z/OS queue manager. On other platforms it must have the value MQCT_NONE - its default value.
public void setDescription(String desc);
Sets the description.
public void setDirectAuth(int authority) throws JMSException;
Sets the type of direct authentication that is required.
public void setFailIfQuiesce(int fiq) throws JMSException;
Sets the default behavior of applications accessing a quiescing queue manager.
public void setHdrCompList(Collection compList) throws JMSException;
Sets the list of header compression techniques.
public void setHostName(String hostname);
Sets the name of the host. This only applies for client connections or direct TCP/IP connections to WebSphere MQ.
public void setLocalAddress(String address) throws JMSException;
Sets the local address.
You can specify a host name instead of an IP address.
Specify a range of ports to allow for connections that are required internally as well as those explicitly used by an application. The number of ports required depends on the application and the facilities it uses. Typically, this is the number of sessions the application uses plus three or four additional ports. If an application is having difficulty making connections, increase the number of ports in the range.
Note that connection pooling has an effect on how quickly a port can be reused. In JMS, connection pooling is switched on by default and it might be some minutes before a port can be reused Connection errors might occur in the meantime.
For direct connections, the local address determines which of the local network interfaces is used for multicast connections. When specifying a local address for a direct connection, do not include a port number. A port number is not valid for multicast and, if specified, causes a failure at connect time.
public void setMapNameStyle(boolean style);
Allows compatibility style to be used for MapMessage element names.
public void setMessageRetention(int mRet) throws JMSException;
Sets what happens to unwanted messages.
public void setMessageSelection(int selection) throws JMSException;
Sets whether the client or the broker performs message selection.
public void setMQConnectionOptions(int cTagOpt) throws JMSException;
Sets the connection options for a queue manager. This method checks that the options are valid for JMS.
public void setMsgBatchSize(int size) throws JMSException;
Sets the message batch size.
public void setMsgCompList(Collection compList) throws JMSException;
Sets the list of message compression techniques.
public void setMulticast(int multicast) throws JMSException;
Sets the value of the multicast attribute.
public void setOptimisticPublication(boolean newVal) throws JMSException;
Determines whether the publish/subscribe MessageProducers can return immediately from a send/publish call rather than wait until the message has completed delivery. If false, failure to deliver the message will only be reported when the message is committed.
public void setOutcomeNotification(boolean newVal) throws JMSException;
Determines whether publish/subscribe MessageConsumers are informed of the outcome of acknowledge or commit calls after receiving messages.
public void setPollingInterval(int interval) throws JMSException;
Sets the interval between scans of all receivers during asynchronous message delivery.
public void setPort(int port) throws JMSException;
Sets the port for a client connection.
public void setProcessDuration(int newVal) throws JMSException;
Sets how promptly received messages are processed. While this alone does not make any difference, quickly processing messages is a prerequisite for viewing uncommitted messages.
public void setProxyHostName(String hostName) throws JMSException;
Sets the proxy host name.
public void setProxyPort(int proxyPort) throws JMSException;
Sets the proxy port attribute.
public void setPubAckInterval(int interval) throws JMSException;
Sets the number of messages that can be published before requiring acknowledgement from the broker. Applications do not normally alter this value, and must not rely on this acknowledgement.
public void setQueueManager(String queueManagerName) throws JMSException;
Sets the name of the queue manager.
public void setReceiveExit(String receiveExit);
Sets the receive exit. When writing exits for use with WebSphere MQ Java, each object must also have a constructor that takes a single string argument. When WebSphere MQ creates an instance of the exit, it will pass any initialization data into the exit using this constructor.
public void setReceiveExitInit(String data);
Sets the initialization string for the receive exit.
public void setReceiveIsolation(int newVal) throws JMSException;
Sets whether calls by MessageConsumers are isolated from other operations.
public void setRescanInterval(int interval) throws JMSException;
Sets the interval between browsing a queue. The scan looks for messages that were not returned by the previous scan.
public void setSecurityExit(String securityExit);
Sets the security exit. When writing exits for use with WebSphere MQ Java, each object must also have a constructor that takes a single string argument. When WebSphere MQ creates an instance of the exit, it will pass any initialization data into the exit using this constructor.
public void setSecurityExitInit(String data);
Sets the initialization string for the security exit.
public void setSendExit(String sendExit);
Sets the send exit. When writing exits for use with WebSphere MQ Java, each object must also have a constructor that takes a single string argument. When WebSphere MQ creates an instance of the exit, it will pass any initialization data into the exit using this constructor.
public void setSendExitInit(String data);
Gets the description of the send exit.
public void setSparseSubscriptions(boolean sparse) throws JMSException;
Sets whether sparse subscriptions are selected. A sparse subscription is one that receives infrequent matching messages.
public void setSSLCertStores(Collection stores);
Provides a collection of CertStore objects used for certificate revocation list (CRL) checking. The certificate provided by the queue manager is checked against one of the CertStore objects contained within the collection; if the certificate is found, the connection attempt fails. At connect-time, each CertStore in the collection is tried in turn until one is successfully used to verify the queue manager's certificate. This property is ignored if sslCipherSuite is null. Use of this property requires Java 2 v1.4. If CertStore objects are specified using this method the MQConnectionFactory cannot be bound into a JNDI namespace. Attempting to do so will result in an exception being thrown.
You must make sure that your Java Software Development Kit (SDK) is compatible with the CRL to use CertStore successfully with a CRL hosted on an LDAP server. Some SDKs require that the CRL conforms to RFC 2587, which defines a schema for LDAP v2. Most LDAP v3 servers use RFC 2256 instead.
public void setSSLCertStores(String stores) throws JMSException;
Specifies a list of LDAP servers used for certificate revocation list (CRL) checking. It allows the user to specify the URIs of LDAP CertStore objects as a String, which is converted internally to the Collection form as required by the CertStore checking routines. This method is provided to support storing the CertStore list via JMSAdmin. Each LDAP server is tried in turn until one is successfully used to verify the queue manager's certificate.
public void setSSLCipherSuite(String cipherSuite);
Sets the CipherSuite used for SSL encryption. Set this to the CipherSuite matching the CipherSpec set on the SVRCONN channel.
public void setSSLFipsRequired(boolean required);
Sets whether sslFips (FIPS) is required.
public void setSSLPeerName(String peerName) throws JMSException;
Sets a distinguished name (DN) pattern. If sslCipherSuite is set, this pattern can ensure that the correct queue manager is used. The connection attempt fails if the distinguished name provided by the queue manager does not match this pattern.
public void setSSLResetCount(int bytes) throws JMSException;
Sets the SSL reset count.
public void setSSLSocketFactory(Object sf);
Sets the SSLSocketFactory for use with SSL encryption. Use this to customize all aspects of SSL encryption. Refer to your JSSE provider's documentation for more information on constructing and customizing SSLSocketFactory instances. If a custom SSLSocketFactory is specified, the MQConnectionFactory cannot be bound into a JNDI namespace. Attempting to do so results in an exception.
public void setStatusRefreshInterval(int interval) throws JMSException;
Sets the status refresh interval.
public void setSubscriptionStore(int flag) throws JMSException;
Sets the SUBSTORE property.
public void setSyncpointAllGets(boolean flag);
Chooses whether to do all GET operations within a syncpoint. The default setting for this property is false.
public void setTargetClientMatching(boolean matchClient);
Enable or disable target client matching. If this is set to true, then only MQMD messages (those from a non-JMS application) containing a replyTo will have a JMS replyTo Destination constructed with targetClient set to JMSC.MQJMS_CLIENT_NONJMS_MQ. This ensures that the reply can be understood by the originator.
If this field is set to false, then replies will always contain an RFH2 header, even though the receiver might not understand the reply.
Note that this applies only to point-to-point destinations. This field is set to true by default.
public void setTemporaryModel(String queueName) throws JMSException;
Sets the name of a model queue for creating temporary destinations.
public void setTempQPrefix(String newTempQPrefix) throws JMSException;
Sets the prefix to be used to form the name of a WebSphere MQ dynamic queue.
public void setTransportType(int type) throws JMSException;
Sets the transport type.
public void setUseConnectionPooling(boolean usePooling);
Chooses whether to use connection pooling. If you set this to true, JMS enables connection pooling for the lifetime of any connections created through the ConnectionFactory. This also affects connections created with usePooling set to false; to disable connection pooling throughout a JVM, ensure that all ConnectionFactories used within the JVM have usePooling set to false.
Notices |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
rconfac |