com.ibm.mq.jms

Class MQConnectionFactory

  • java.lang.Object
    • com.ibm.msg.client.jms.internal.JmsReadablePropertyContextImpl
      • com.ibm.msg.client.jms.internal.JmsPropertyContextImpl
        • com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
          • com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
            • com.ibm.mq.jms.MQConnectionFactory
  • All Implemented Interfaces:
    JmsConnectionFactory, JmsPropertyContext, JmsReadablePropertyContext, com.ibm.msg.client.provider.ProviderPropertyContextCallback, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, javax.jms.ConnectionFactory, javax.naming.Referenceable
    Direct Known Subclasses:
    Cleanup, MQQueueConnectionFactory, MQTopicConnectionFactory, MQXAConnectionFactory

    public class MQConnectionFactory
extends com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
    MQConnectionFactory is the IBM MQ implementation of ConnectionFactory. A connection factory 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.

    If the application passes an empty string or a null value for the User ID when creating a connection, then the User ID that started either the JVM or the application server will be sent to the queue manager for authentication.

    See Also:
    Connection, QueueConnectionFactory, TopicConnectionFactory, Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  MQConnectionFactory.ConnectionFactoryProperty
      This enumeration represents all the Administrative Properties of MQConnectionFactory objects.

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K,V>

    • Constructor Summary

      Constructors 
      Constructor and Description
      MQConnectionFactory()
      Default constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      javax.jms.Connection createConnection()
      Creates a connection with the default user identity.
      javax.jms.Connection createConnection(java.lang.String userID, java.lang.String password)
      Creates a connection with the specified user identity.
      java.lang.String getAppName() 
      int getAsyncExceptions()
      Gets the exception types that will be passed to the user's async exception listener
      java.lang.String getBrokerCCSubQueue()
      Gets the broker's queue name for nondurable connection consumers.
      java.lang.String getBrokerControlQueue()
      Gets the broker's control queue name.
      java.lang.String getBrokerPubQueue()
      Gets the broker's publish queue name.
      java.lang.String getBrokerQueueManager()
      Gets the name of the broker's queue manager.
      java.lang.String getBrokerSubQueue()
      Gets the broker's queue name for subscribers.
      int getBrokerVersion()
      Gets the version number of the broker.
      java.net.URL getCCDTURL()
      Gets the URL for the client channel definition table.
      int getCCSID()
      Gets the character set of the queue manager.
      java.lang.String getChannel()
      Gets the name of the channel that was used.
      long getCleanupInterval()
      Gets the clean up interval.
      int getCleanupLevel()
      Gets the clean up level.
      java.lang.String getClientId()
      Deprecated. 
      Gets the client ID.
      java.lang.String getClientID()
      Gets the client ID.
      int getClientReconnectOptions()
      Get the client reconnection options
      int getClientReconnectTimeout()
      Get the amount of time, in seconds, that a client connection will attempt to reconnect.
      java.lang.String getConnectionNameList()
      Get the hosts to which the client will attempt to connect to
      byte[] getConnTag()
      Gets the value of the queue manager connection tag.
      java.lang.String getDescription()
      Gets the description.
      int getDirectAuth()
      Deprecated.  
      int getFailIfQuiesce()
      Indicates the default behavior of applications accessing a quiescing queue manager.
      java.util.Collection<java.lang.Object> getHdrCompList()
      Gets the list of header compression techniques which has been set.
      java.lang.String getHostName()
      Gets the name of the host.
      java.lang.String getLocalAddress()
      Gets the local address.
      boolean getMapNameStyle()
      Allows compatibility style to be used for map message element names.
      int getMaxBufferSize()
      Gets the maximum buffer size.
      int getMessageRetention()
      Indicates what happens to unwanted messages.
      int getMessageSelection()
      Indicates whether the client or the broker performs message selection.
      int getMQConnectionOptions()
      Gets the connection options.
      int getMsgBatchSize()
      Gets the message batch size.
      java.util.Collection<? extends java.lang.Object> getMsgCompList()
      Gets the list of message compression techniques that have been set.
      int getMulticast()
      Deprecated.  
      int getPollingInterval()
      Gets the interval between scans of all receivers during asynchronous message delivery.
      int getPort()
      Gets the port number.
      java.lang.String getProviderVersion()
      Gets the provider version that should be used when creating connections.
      java.lang.String getProxyHostName()
      Deprecated.  
      int getProxyPort()
      Gets the port number of the proxy server.
      int getPubAckInterval()
      Gets the number of messages that can be published before requiring acknowledgement from the broker.
      java.lang.String getQueueManager()
      Gets the name of the queue manager.
      java.lang.String getReceiveExit()
      Gets the description of the receive exit.
      java.lang.String getReceiveExitInit()
      Gets the initialization string for the receive exit.
      javax.naming.Reference getReference()
      Creates a reference for this queue connection factory.
      int getRescanInterval()
      Gets the interval between browse scans of a queue.
      java.lang.String getSecurityExit()
      Gets the description of the security exit.
      java.lang.String getSecurityExitInit()
      Gets the initialization string for the security exit.
      int getSendCheckCount()
      Gets the interval between send calls to check for errors on asynchronous put.
      java.lang.String getSendExit()
      Gets the description of the send exit.
      java.lang.String getSendExitInit()
      Gets the initialization string for the send exit.
      int getShareConvAllowed()
      Gets a value indicating whether client connections are sharing their socket (conversation)
      boolean getSparseSubscriptions()
      Gets the sparse subscriptions attribute.
      java.util.Collection<? extends java.lang.Object> getSSLCertStores()
      Gets the collection of CertStore objects.
      java.lang.String getSSLCertStoresAsString()
      Gets the collection of CertStore objects as a String.
      java.lang.String getSSLCipherSuite()
      Gets the CipherSuite used for SSL encryption.
      boolean getSSLFipsRequired()
      Indicates whether sslFips (FIPS) is required.
      java.lang.String getSSLPeerName()
      Gets the distinguished name pattern used to validate the queue manager.
      int getSSLResetCount()
      Gets the SSL reset count.
      java.lang.Object getSSLSocketFactory()
      Gets the SSLSocketFactory used with SSL encryption.
      int getStatusRefreshInterval()
      Gets the status refresh interval.
      int getSubscriptionStore()
      Gets the SUBSTORE property.
      boolean getSyncpointAllGets()
      Indicates how syncpoint is used for GET operations.
      boolean getTargetClientMatching()
      is target client matching enabled.
      java.lang.String getTemporaryModel()
      Gets the name of a model queue for creating temporary destinations.
      java.lang.String getTempQPrefix()
      Gets the prefix used to form the name of an IBM MQ dynamic queue.
      java.lang.String getTempTopicPrefix()
      Gets the prefix to use when creating temporary topic names.
      int getTransportType()
      Gets the transport type.
      boolean getUseConnectionPooling()
      Deprecated. 
      as noted in setUseConnectionPooling(boolean usePooling) this property has no effect in the current release
      int getVersion()
      Gets the version number.
      int getWildcardFormat()
      Gets the formatting accepted when using wildcards.
      void setAppName(java.lang.String name)
      Set the application name on the connection factory
      void setAsyncExceptions(int flags)
      Sets the exception types that should be passed to the user's exception listener.
      void setBrokerCCSubQueue(java.lang.String queueName)
      Sets the name of the broker nondurable connection consumer subscriber queue.
      void setBrokerControlQueue(java.lang.String queueName)
      Sets the name of the broker control queue.
      void setBrokerPubQueue(java.lang.String queueName)
      Sets the name of the broker's publish queue.
      void setBrokerQueueManager(java.lang.String queueManagerName)
      Sets the name of the broker's queue manager.
      void setBrokerSubQueue(java.lang.String queueName)
      Sets the name of the broker nondurable subscriber queue.
      void setBrokerVersion(int version)
      Sets the version of the broker.
      void setCCDTURL(java.net.URL url)
      Sets the URL for the client channel definition table.
      void setCCSID(int ccsid)
      Sets the character set to be used when connecting to the queue manager.
      void setChannel(java.lang.String channelName)
      Sets the name of the channel - applies to client transport mode only.
      void setCleanupInterval(long interval)
      Sets the clean up interval.
      void setCleanupLevel(int level)
      Sets the clean up level.
      void setClientId(java.lang.String id)
      Deprecated. 
      Sets the client ID.

      Note that this method always throws an IllegalStateException when you make a real-time connection to a broker.
      void setClientID(java.lang.String id)
      Sets the client ID.
      void setClientReconnectOptions(int options)
      Specifies the client reconnect options for new connections created by this factory.
      void setClientReconnectTimeout(int timeout)
      Set the amount of time, in seconds, that a client connection will attempt to reconnect.
      void setConnectionNameList(java.lang.String hosts)
      Specifies the hosts to which the client will attempt to reconnect to after its connection is broken.
      void setConnTag(byte[] cTag)
      Sets the value of the queue manager connection tag.
      void setDescription(java.lang.String desc)
      Sets the description.
      void setDirectAuth(int authority)
      Deprecated.  
      void setFailIfQuiesce(int fiq)
      Sets the default behavior of applications accessing a quiescing queue manager.
      void setHdrCompList(java.util.Collection<?> compList)
      Sets the list of header compression techniques.
      void setHostName(java.lang.String hostname)
      Sets the name of the host.
      void setLocalAddress(java.lang.String address)
      Sets the local address.
      void setMapNameStyle(boolean style)
      Allows compatibility style to be used for map message element names.
      void setMaxBufferSize(int size)
      Sets the maximum buffer size.
      void setMessageRetention(int mRet)
      Sets what happens to unwanted messages.
      void setMessageSelection(int selection)
      Sets whether the client or the broker performs message selection.
      void setMQConnectionOptions(int cTagOpt)
      Sets the connection options for a queue manager.
      void setMsgBatchSize(int size)
      Sets the message batch size.
      void setMsgCompList(java.util.Collection<?> compList)
      Sets the list of message compression techniques.
      void setMulticast(int multicast)
      Deprecated.  
      void setPollingInterval(int interval)
      Sets the interval between scans of all receivers during asynchronous message delivery.
      void setPort(int port)
      Sets the port for a client connection.
      void setProviderVersion(java.lang.String version)
      Sets the provider version that should be used when creating connections.
      void setProxyHostName(java.lang.String hostName)
      Deprecated.  
      void setProxyPort(int proxyPort)
      Deprecated.  
      void setPubAckInterval(int interval)
      Sets the number of messages that can be published before requiring acknowledgement from the broker.
      void setQueueManager(java.lang.String queueManagerName)
      Sets the name of the queue manager.
      void setReceiveExit(java.lang.String receiveExit)
      Sets the receive exit.
      void setReceiveExitInit(java.lang.String data)
      Sets the initialization string for the receive exit.
      void setRescanInterval(int interval)
      Sets the interval between browsing a queue.
      void setSecurityExit(java.lang.String securityExit)
      Sets the security exit.
      void setSecurityExitInit(java.lang.String data)
      Sets the initialization string for the security exit.
      void setSendCheckCount(int interval)
      Sets the interval between send calls to check for errors on asynchronous put.
      void setSendExit(java.lang.String sendExit)
      Sets the send exit.
      void setSendExitInit(java.lang.String data)
      Gets the description of the send exit.
      void setShareConvAllowed(int shared)
      Sets whether client connections can share their socket (conversation)
      void setSparseSubscriptions(boolean sparse)
      Sets whether sparse subscriptions are selected.
      void setSSLCertStores(java.util.Collection<?> stores)
      Provides a collection of CertStore objects used for certificate revocation list (CRL) checking.
      void setSSLCertStores(java.lang.String stores)
      Specifies a list of LDAP servers used for certificate revocation list (CRL) checking.
      void setSSLCipherSuite(java.lang.String cipherSuite)
      Sets the CipherSuite used for SSL encryption.
      void setSSLFipsRequired(boolean required)
      Sets whether sslFips (FIPS) is required.
      void setSSLPeerName(java.lang.String peerName)
      Sets a distinguished name (DN) pattern.
      void setSSLResetCount(int bytes)
      Sets the SSL reset count.
      void setSSLSocketFactory(java.lang.Object sf)
      Sets the SSLSocketFactory for use with SSL encryption.
      void setStatusRefreshInterval(int interval)
      Sets the status refresh interval.
      void setSubscriptionStore(int flag)
      Sets the SUBSTORE property.
      void setSyncpointAllGets(boolean flag)
      Chooses whether to do all GET operations within a syncpoint.
      void setTargetClientMatching(boolean matchClient)
      Enables or disables target client matching.
      void setTemporaryModel(java.lang.String queueName)
      Sets the name of an IBM MQ model queue used when creating JMS temporary destinations.
      void setTempQPrefix(java.lang.String newTempQPrefix)
      Sets the prefix to be used to form the name of an IBM MQ dynamic queue.
      void setTempTopicPrefix(java.lang.String prefix)
      Sets the prefix to use when creating temporary topic names.
      void setTransportType(int type)
      Sets the transport type.
      void setUseConnectionPooling(boolean usePooling)
      Deprecated. 
      JMS does not use connection pooling anymore. Any connection pooling should be done using the facilities provided by the App Server.
      void setWildcardFormat(int format)
      Sets the formatting to accept when using wildcards.

      • Methods inherited from class com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl

        createContext, createContext, createContext, createContext, equals, hashCode

      • Methods inherited from class com.ibm.msg.client.jms.internal.JmsPropertyContextImpl

        clear, containsKey, containsValue, entrySet, get, getObjectProperty, isEmpty, keySet, propertyExists, put, putAll, remove, setBatchProperties, setBooleanProperty, setByteProperty, setBytesProperty, setCharProperty, setDoubleProperty, setFloatProperty, setIntProperty, setLongProperty, setObjectProperty, setProviderPropertyContext, setShortProperty, setStringProperty, size, values

      • Methods inherited from class com.ibm.msg.client.jms.internal.JmsReadablePropertyContextImpl

        dump, getBooleanProperty, getByteProperty, getBytesProperty, getCharProperty, getDoubleProperty, getFloatProperty, getIntProperty, getLongProperty, getPropertyNames, getShortProperty, getStringProperty, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

    • Constructor Detail

      • MQConnectionFactory

        public MQConnectionFactory()
        Default constructor.

    • Method Detail

      • getBrokerCCSubQueue

        public java.lang.String getBrokerCCSubQueue()
                                     throws javax.jms.JMSException
        Gets the broker's queue name for nondurable connection consumers.
        Returns:
        the name of the queue.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getBrokerControlQueue

        public java.lang.String getBrokerControlQueue()
                                       throws javax.jms.JMSException
        Gets the broker's control queue name.
        Returns:
        the name of the control queue.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getBrokerPubQueue

        public java.lang.String getBrokerPubQueue()
                                   throws javax.jms.JMSException
        Gets the broker's publish queue name.
        Returns:
        the name of the queue.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getBrokerQueueManager

        public java.lang.String getBrokerQueueManager()
                                       throws javax.jms.JMSException
        Gets the name of the broker's queue manager.
        Returns:
        the name of the queue manager.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getBrokerSubQueue

        public java.lang.String getBrokerSubQueue()
                                   throws javax.jms.JMSException
        Gets the broker's queue name for subscribers.
        Returns:
        the name of the queue.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getBrokerVersion

        public int getBrokerVersion()
                     throws javax.jms.JMSException
        Gets the version number of the broker.
        Returns:
        the version number.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getCCDTURL

        public java.net.URL getCCDTURL()
        Gets the URL for the client channel definition table.
        Returns:
        the address of the client channel definition table.

      • getCCSID

        public int getCCSID()
        Gets the character set of the queue manager.
        Returns:
        the CCSID.

      • getChannel

        public java.lang.String getChannel()
        Gets the name of the channel that was used.
        Returns:
        the name of the channel.

      • getCleanupInterval

        public long getCleanupInterval()
                        throws javax.jms.JMSException
        Gets the clean up interval.
        Returns:
        the clean up interval (milliseconds).
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getCleanupLevel

        public int getCleanupLevel()
                    throws javax.jms.JMSException
        Gets the clean up level.
        Returns:
        the clean up level.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getClientID

        public java.lang.String getClientID()
        Gets the client ID.
        Returns:
        the client ID for all connections made using this factory.

        Note that this method always throws an IllegalStateException when you make a direct connection to a broker.

      • getClientId

        public java.lang.String getClientId()
        Deprecated. Gets the client ID.
        Returns:
        the client ID for all connections made using this factory.

        Note that this method always throws an IllegalStateException when you make a direct connection to a broker.

      • getConnTag

        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 a value corresponding to MQCT_NONE - its default value.
        Returns:
        the String value of the queue manager connection tag.

      • getDescription

        public java.lang.String getDescription()
        Gets the description.
        Returns:
        the object description.

      • getDirectAuth

        public int getDirectAuth()
                  throws javax.jms.JMSException
        Deprecated. 
        This method was deprecated in a previous version and is no longer supported.
        Returns:
        the appropriate constant value
        Throws:
        javax.jms.JMSException

      • getHdrCompList

        public java.util.Collection<java.lang.Object> getHdrCompList()
        Gets the list of header compression techniques which has been set.
        Returns:
        The collection that holds the header compression techniques. If not set, this collection has a value of null

      • getHostName

        public java.lang.String getHostName()
        Gets the name of the host. This only applies for client connections or direct TCP/IP connections to IBM MQ.
        Returns:
        the name of the host.

      • getLocalAddress

        public java.lang.String getLocalAddress()
        Gets the local address.
        Returns:
        the local address.

      • getMaxBufferSize

        public int getMaxBufferSize()
                     throws javax.jms.JMSException
        Gets the maximum buffer size. This is the maximum number of received messages that can be stored in an internal message buffer while waiting to be processed by the client application. This property applies only when TRANSPORT has the values DIRECT or DIRECTHTTP.
        Returns:
        the maximum buffer size.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getMessageRetention

        public int getMessageRetention()
                        throws javax.jms.JMSException
        Indicates what happens to unwanted messages.
        Returns:
        possible values are:
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getMessageSelection

        public int getMessageSelection()
                        throws javax.jms.JMSException
        Indicates whether the client or the broker performs message selection.
        Returns:
        possible values are:
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getMQConnectionOptions

        public int getMQConnectionOptions()
        Gets the connection options.
        Returns:
        the connection options set for the queue manager

      • getMsgBatchSize

        public int getMsgBatchSize()
        Gets the message batch size.
        Returns:
        the maximum number of messages to be taken at once when using asynchronous delivery.

      • getMsgCompList

        public java.util.Collection<? extends java.lang.Object> getMsgCompList()
        Gets the list of message compression techniques that have been set.
        Returns:
        the collection holding the message compression techniques. If not set, this collection has a value of null

      • getMulticast

        public int getMulticast()
                 throws javax.jms.JMSException
        Deprecated. 
        This method was deprecated in a previous version and is no longer supported.
        Returns:
        The appropriate constant value
        Throws:
        javax.jms.JMSException

      • getPollingInterval

        public int getPollingInterval()
        Gets the interval between scans of all receivers during asynchronous message delivery.
        Returns:
        the interval in milliseconds.

      • getPort

        public int getPort()
        Gets the port number. Applies to client connections or direct TCP/IP connection to a broker.
        Returns:
        the port number.

      • getProviderVersion

        public java.lang.String getProviderVersion()
                                    throws javax.jms.JMSException
        Gets the provider version that should be used when creating connections.
        Returns:
        value of the form V.R.M.F or abbreviated forms such as V or V.R, where V, R, M and F are integers representing the version, release, modification level and fixpack. Alternatively, the String value can be set to unspecified.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getProxyHostName

        public java.lang.String getProxyHostName()
                                  throws javax.jms.JMSException
        Deprecated. 
        Gets the proxy host name. This property is no longer supported
        Returns:
        the host name of the proxy server when establishing a real-time connection, or null if no proxy server is used.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getProxyPort

        public int getProxyPort()
                 throws javax.jms.JMSException
        Gets the port number of the proxy server.
        Returns:
        the port number of the proxy server.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getPubAckInterval

        public int getPubAckInterval()
                      throws javax.jms.JMSException
        Gets the number of messages that can be published before requiring acknowledgement from the broker.
        Returns:
        the acknowledgement interval.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getQueueManager

        public java.lang.String getQueueManager()
        Gets the name of the queue manager.
        Returns:
        the name.
        See Also:
        setQueueManager(String)

      • getReceiveExit

        public java.lang.String getReceiveExit()
        Gets the description of the receive exit.
        Returns:
        either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • getReceiveExitInit

        public java.lang.String getReceiveExitInit()
        Gets the initialization string for the receive exit.
        Returns:
        the initialization string.

      • getReference

        public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException
        Creates a reference for this queue connection factory. Implemented for the javax.naming.Reference interface.
        Specified by:
        getReference in interface javax.naming.Referenceable
        Overrides:
        getReference in class com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
        Returns:
        the new Reference object.
        Throws:
        javax.naming.NamingException - if there is a naming problem.

      • getRescanInterval

        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.
        Returns:
        the interval in milliseconds.

      • getSecurityExit

        public java.lang.String getSecurityExit()
        Gets the description of the security exit.
        Returns:
        either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • getSecurityExitInit

        public java.lang.String getSecurityExitInit()
        Gets the initialization string for the security exit.
        Returns:
        the initialization string.

      • getSendCheckCount

        public int getSendCheckCount()
                      throws javax.jms.JMSException
        Gets the interval between send calls to check for errors on asynchronous put.
        Returns:
        value to indicate the interval between send calls to check for asynchronous put errors, measured as a count of message sends within a single non-transacted JMS Session.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getSendExit

        public java.lang.String getSendExit()
        Gets the description of the send exit.
        Returns:
        either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • getSendExitInit

        public java.lang.String getSendExitInit()
        Gets the initialization string for the send exit.
        Returns:
        the initialization string.

      • getShareConvAllowed

        public int getShareConvAllowed()
                        throws javax.jms.JMSException
        Gets a value indicating whether client connections are sharing their socket (conversation)
        Returns:
        1 indicates that the connection is allowed to share the socket with other top-level JMS connections from the same process to the same queue manager, provided that the channel definitions match. 0 indicates that this is not permitted.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getSparseSubscriptions

        public boolean getSparseSubscriptions()
                               throws javax.jms.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.
        Returns:
        true if sparse subscriptions are selected.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getSSLCertStores

        public java.util.Collection<? extends java.lang.Object> getSSLCertStores()
                                                                  throws javax.jms.JMSException
        Gets the collection of CertStore objects.
        Returns:
        the list of CertStore objects as a Collection. This works whether setSSLCertStores(Collection)was used to set a collection of CertStore objects or a String specifying such a list.
        Throws:
        javax.jms.JMSException - if an unsupported type or bad value is encountered.

      • getSSLCertStoresAsString

        public java.lang.String getSSLCertStoresAsString()
                                          throws javax.jms.JMSException
        Gets the collection of CertStore objects as a String.
        Returns:
        the list of CertStore objects representing the LDAP CRLs as a String if setSSLCertStores(String)set it as a String in the first place.
        Throws:
        javax.jms.JMSException - if the CertStore objects were provided as a Collection.

      • getSSLCipherSuite

        public java.lang.String getSSLCipherSuite()
        Gets the CipherSuite used for SSL encryption.
        Returns:
        the CipherSuite String.

      • getSSLFipsRequired

        public boolean getSSLFipsRequired()
        Indicates whether sslFips (FIPS) is required.
        Returns:
        the value.

      • getSSLPeerName

        public java.lang.String getSSLPeerName()
        Gets the distinguished name pattern used to validate the queue manager.
        Returns:
        the distinguished name pattern.

      • getSSLResetCount

        public int getSSLResetCount()
        Gets the SSL reset count.
        Returns:
        the reset count.

      • getSSLSocketFactory

        public java.lang.Object getSSLSocketFactory()
        Gets the SSLSocketFactory used with SSL encryption.
        Returns:
        the SSLSocketFactory.

      • getStatusRefreshInterval

        public int getStatusRefreshInterval()
                             throws javax.jms.JMSException
        Gets the status refresh interval.
        Returns:
        the time between transactions to refresh publish/subscribe status (milliseconds).
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getSyncpointAllGets

        public boolean getSyncpointAllGets()
        Indicates how syncpoint is used for GET operations.
        Returns:
        true if all message GET operations are done under syncpoint. Otherwise GET operations for non-transacted sessions using javax.jms.ProviderSession.AUTO_ACKNOWLEDGE or javax.jms.ProviderSession.DUPS_OK_ACKNOWLEDGE acknowledge modes can do GETs outside syncpoint.

      • getTargetClientMatching

        public boolean getTargetClientMatching()
        is target client matching enabled.
        Returns:
        whether target client matching is enabled.
        See Also:
        setTargetClientMatching(boolean)

      • getTemporaryModel

        public java.lang.String getTemporaryModel()
                                   throws javax.jms.JMSException
        Gets the name of a model queue for creating temporary destinations.
        Returns:
        the name of the model queue. If it refers to a permanent dynamic model queue then you must call the MQTemporaryQueue.delete()method to destroy the queue after use.

        Within the WebSphere Application Server, MQTemporaryQueue.delete() will be called by the application server when a connection is being closed. Therefore even if a permanent dynamic model queue is used, the created temporary queue will be destroyed.

        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getTempTopicPrefix

        public java.lang.String getTempTopicPrefix()
                                    throws javax.jms.JMSException
        Gets the prefix to use when creating temporary topic names.
        Returns:
        String property applicable to all instances of ConnectionFactory, TopicConnectionFactory and their XA equivalents. When creating temporary topics, JMS will generate a topic string of the form TEMP/prefix/<unique id>, or if this property is left with the default value, just TEMP/<unique id>.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getTempQPrefix

        public java.lang.String getTempQPrefix()
                                throws javax.jms.JMSException
        Gets the prefix used to form the name of an IBM MQ dynamic queue.
        Returns:
        the prefix.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getTransportType

        public int getTransportType()
        Gets the transport type.
        Returns:
        the transport type. Valid types are: DirectIP transport types can still be set but are no longer supported, so will throw an Exception when trying to create a Connection

      • getVersion

        public int getVersion()
        Gets the version number.
        Returns:
        the version number of the class.

      • getWildcardFormat

        public int getWildcardFormat()
                      throws javax.jms.JMSException
        Gets the formatting accepted when using wildcards.
        Returns:
        property applicable to all instances of ConnectionFactory, TopicConnectionFactory and their XA equivalents. In the v6 implementation, where publish/subscribe messaging is performed via a broker, different topic wildcard syntax is used depending on which broker is used. In v7, using native publish/subscribe within the queue manager, the wildcard syntax can be chosen via this property.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • getAppName

        public java.lang.String getAppName()
        Returns:
        the application name set on the connection factory

      • getAsyncExceptions

        public int getAsyncExceptions()
        Gets the exception types that will be passed to the user's async exception listener
        Returns:
        the ASYNC_EXCEPTIONS_* bitwise flags

      • setBrokerCCSubQueue

        public void setBrokerCCSubQueue(java.lang.String queueName)
                         throws javax.jms.JMSException
        Sets the name of the broker nondurable connection consumer subscriber queue.
        Parameters:
        queueName - the name of queue.
        Throws:
        javax.jms.JMSException - if queueName is either null or invalid.

      • setBrokerControlQueue

        public void setBrokerControlQueue(java.lang.String queueName)
                           throws javax.jms.JMSException
        Sets the name of the broker control queue.
        Parameters:
        queueName - the name of the broker control queue.
        Throws:
        javax.jms.JMSException - if the name is either null or invalid.

      • setBrokerPubQueue

        public void setBrokerPubQueue(java.lang.String queueName)
                       throws javax.jms.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.
        Parameters:
        queueName - the name of the publish queue.
        Throws:
        javax.jms.JMSException - if queueName is either null or invalid.

      • setBrokerQueueManager

        public void setBrokerQueueManager(java.lang.String queueManagerName)
                           throws javax.jms.JMSException
        Sets the name of the broker's queue manager.
        Parameters:
        queueManagerName - the name of the queue manager.
        Throws:
        javax.jms.JMSException - if queueManagerName is either null or invalid.

      • setBrokerSubQueue

        public void setBrokerSubQueue(java.lang.String queueName)
                       throws javax.jms.JMSException
        Sets the name of the broker nondurable subscriber queue.
        Parameters:
        queueName - the name of the queue.
        Throws:
        javax.jms.JMSException - if queueName is either null or invalid.

      • setCCDTURL

        public void setCCDTURL(java.net.URL url)
        Sets the URL for the client channel definition table.
        Parameters:
        url - the address of the client channel definition table.

      • setCCSID

        public void setCCSID(int ccsid)
              throws javax.jms.JMSException
        Sets the character set to be used when connecting to the queue manager.
        Parameters:
        ccsid - the CCSID. The default value (819) is suitable in most situations.
        Throws:
        javax.jms.JMSException - if the value of ccsid is not permitted.

      • setChannel

        public void setChannel(java.lang.String channelName)
                throws javax.jms.JMSException
        Sets the name of the channel - applies to client transport mode only.
        Parameters:
        channelName - the name of the channel.
        Throws:
        javax.jms.JMSException - if channelName is either null or too long.

      • setCleanupInterval

        public void setCleanupInterval(long interval)
                        throws javax.jms.JMSException
        Sets the clean up interval.
        Parameters:
        interval - the clean up interval (milliseconds).
        Throws:
        javax.jms.JMSException - if interval is either null or too long.

      • setClientID

        public void setClientID(java.lang.String id)
        Sets the client ID.

        Note that this method always throws an IllegalStateException when you make a real-time connection to a broker.

        Parameters:
        id - the client ID.

      • setClientId

        public void setClientId(java.lang.String id)
        Deprecated. Sets the client ID.

        Note that this method always throws an IllegalStateException when you make a real-time connection to a broker.

        Parameters:
        id - the client ID.

      • setConnTag

        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 should have a value equivalent to MQCT_NONE - its default value.
        Parameters:
        cTag - the connection tag. The value is truncated if it is longer than 128 bytes.

      • setDescription

        public void setDescription(java.lang.String desc)
        Sets the description.
        Parameters:
        desc - the description.

      • setDirectAuth

        public void setDirectAuth(int authority)
                   throws javax.jms.JMSException
        Deprecated. 
        This method was deprecated in a previous version and is no longer supported.
        Parameters:
        authority - the value to set
        Throws:
        javax.jms.JMSException

      • setFailIfQuiesce

        public void setFailIfQuiesce(int fiq)
                      throws javax.jms.JMSException
        Sets the default behavior of applications accessing a quiescing queue manager.
        Parameters:
        fiq - acceptable values are:
        Throws:
        javax.jms.JMSException - if fiq is neither of the above.

      • setHdrCompList

        public void setHdrCompList(java.util.Collection<?> compList)
                    throws javax.jms.JMSException
        Sets the list of header compression techniques.
        Parameters:
        compList - The Collection of header compression techniques to set. The first item in the list to match the server list becomes the current header compression technique.
        Throws:
        javax.jms.JMSException

      • setHostName

        public void setHostName(java.lang.String hostname)
        Sets the name of the host. This only applies for client connections or direct TCP/IP connections to IBM MQ.
        Parameters:
        hostname - the name of the host.

      • setLocalAddress

        public void setLocalAddress(java.lang.String address)
                     throws javax.jms.JMSException
        Sets the local address.
        Parameters:
        address - the local address to be used. The format of a local address is [ip-addr][(low-port[,high-port])]. Here are some examples:
        9.20.4.98
        The channel binds to address 9.20.4.98 locally.
        9.20.4.98(1000)
        The channel binds to address 9.20.4.98 locally and uses port 1000.
        9.20.4.98(1000,2000)
        The channel binds to address 9.20.4.98 locally and uses a port in the range 1000 to 2000.
        (1000)
        The channel binds to port 1000 locally.
        (1000,2000)
        The channel binds to a port in the range 1000 to 2000 locally.

        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 real-time connections, the local address determines which of the local network interfaces is used for multicast connections. When specifying a local address for a real-time connection, do not include a port number. A port number is not valid for multicast and, if specified, causes a failure at connect time.

        Throws:
        javax.jms.JMSException - if the format of the local address is incorrect.

      • setMaxBufferSize

        public void setMaxBufferSize(int size)
                      throws javax.jms.JMSException
        Sets the maximum buffer size. This is the maximum number of received messages that can be stored in an internal message buffer while waiting to be processed by the client application. This property applies only when TRANSPORT has the values DIRECT or DIRECTHTTP.
        Parameters:
        size - the maximum buffer size.
        Throws:
        javax.jms.JMSException - if size is negative.

      • setMessageRetention

        public void setMessageRetention(int mRet)
                         throws javax.jms.JMSException
        Sets what happens to unwanted messages.
        Parameters:
        mRet - possible values are:
        Throws:
        javax.jms.JMSException - if mRet is not one of the above.

      • setMessageSelection

        public void setMessageSelection(int selection)
                         throws javax.jms.JMSException
        Sets whether the client or the broker performs message selection.
        Parameters:
        selection - possible values are:
        Throws:
        javax.jms.JMSException - if selection is not one of the above.

      • setMQConnectionOptions

        public void setMQConnectionOptions(int cTagOpt)
                            throws javax.jms.JMSException
        Sets the connection options for a queue manager. This method checks that the options are valid for JMS.
        Parameters:
        cTagOpt - an int representing the connection options. Only one of the four options relating to connection tags and any of the four options relating to binding type can be set. The only default option set is WMQConstants.MQCNO_STANDARD_BINDING.
        Throws:
        javax.jms.JMSException - if an option or a combination of set options is invalid.

      • setMsgBatchSize

        public void setMsgBatchSize(int size)
                     throws javax.jms.JMSException
        Sets the message batch size.
        Parameters:
        size - the maximum number of messages to be taken at once when using asynchronous delivery.
        Throws:
        javax.jms.JMSException

      • setMsgCompList

        public void setMsgCompList(java.util.Collection<?> compList)
                    throws javax.jms.JMSException
        Sets the list of message compression techniques.
        Parameters:
        compList - the Collection of message compression techniques to set. The first item in the list to match the server list becomes the current message compression technique.
        Throws:
        javax.jms.JMSException

      • setMulticast

        public void setMulticast(int multicast)
                  throws javax.jms.JMSException
        Deprecated. 
        This method was deprecated in a previous version and is no longer supported.
        Parameters:
        multicast - the value to set
        Throws:
        javax.jms.JMSException

      • setPollingInterval

        public void setPollingInterval(int interval)
                        throws javax.jms.JMSException
        Sets the interval between scans of all receivers during asynchronous message delivery.
        Parameters:
        interval - the interval in milliseconds.
        Throws:
        javax.jms.JMSException

      • setPort

        public void setPort(int port)
             throws javax.jms.JMSException
        Sets the port for a client connection.
        Parameters:
        port - the new value to use.
        Throws:
        javax.jms.JMSException - if port is not a permitted value.

      • setProviderVersion

        public void setProviderVersion(java.lang.String version)
                        throws javax.jms.JMSException
        Sets the provider version that should be used when creating connections.
        Parameters:
        version - value of the form V.R.M.F or abbreviated forms such as V or V.R, where V, R, M and F are integers representing the version, release, modification level and fixpack. Alternatively, the String value can be set to WMQConstants.WMQ_PROVIDER_VERSION_DEFAULT which has a value of "unspecified".
        Throws:
        javax.jms.JMSException - if the version is invalid

      • setProxyHostName

        public void setProxyHostName(java.lang.String hostName)
                      throws javax.jms.JMSException
        Deprecated. 
        This method was deprecated in a previous version and is no longer supported.
        Parameters:
        hostName - the host name of the proxy server when establishing a real-time connection, or null if no proxy server is used.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setProxyPort

        public void setProxyPort(int proxyPort)
                  throws javax.jms.JMSException
        Deprecated. 
        This method was deprecated in a previous version and is no longer supported.
        Parameters:
        proxyPort - the port number of the proxy server when establishing a real-time connection.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setPubAckInterval

        public void setPubAckInterval(int interval)
                       throws javax.jms.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.
        Parameters:
        interval - the number of messages to use as an interval. The default is 25.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setQueueManager

        public void setQueueManager(java.lang.String queueManagerName)
                     throws javax.jms.JMSException
        Sets the name of the queue manager.
        Parameters:
        queueManagerName - the queue manager which is used when selecting a channel definition. This can be in of the following forms:
        • "qMgrName", where the actual name of the required queue manager is passed in. The channel must connect to a queue manager of this name.
        • "*qMgrName", where "*" followed by the actual name of the required queue manager is passed in. The channel definition that is used must specify this queue manager name. This full name is passed onto the queueManager during a connect, but the queue manager that is ultimately connected to may not have the same name as specified here after the '*'.
        Throws:
        javax.jms.JMSException - if queueManagerName is either null or too long.

      • setReceiveExit

        public void setReceiveExit(java.lang.String receiveExit)
        Sets the receive exit. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it will pass any initialization data into the exit using this constructor.
        Parameters:
        receiveExit - either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • setReceiveExitInit

        public void setReceiveExitInit(java.lang.String data)
        Sets the initialization string for the receive exit.
        Parameters:
        data - the initialization string.

      • setRescanInterval

        public void setRescanInterval(int interval)
                       throws javax.jms.JMSException
        Sets the interval between browsing a queue. The scan looks for messages that were not returned by the previous scan.
        Parameters:
        interval - the interval in milliseconds.
        Throws:
        javax.jms.JMSException

      • setSecurityExit

        public void setSecurityExit(java.lang.String securityExit)
        Sets the security exit. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it will pass any initialization data into the exit using this constructor.
        Parameters:
        securityExit - either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • setSecurityExitInit

        public void setSecurityExitInit(java.lang.String data)
        Sets the initialization string for the security exit.
        Parameters:
        data - the initialization string.

      • setSendCheckCount

        public void setSendCheckCount(int interval)
                       throws javax.jms.JMSException
        Sets the interval between send calls to check for errors on asynchronous put.
        Parameters:
        interval - value to indicate the interval between send calls to check for asynchronous put errors, measured as a count of message sends within a single non-transacted JMS Session.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setSendExit

        public void setSendExit(java.lang.String sendExit)
        Sets the send exit. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it will pass any initialization data into the exit using this constructor.
        Parameters:
        sendExit - either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • setSendExitInit

        public void setSendExitInit(java.lang.String data)
        Gets the description of the send exit.
        Parameters:
        data - either the name of the class or a String in the form library(entryPoint) where 'library' is the name of the module where the code resides and 'entryPoint' is the entry point.

      • setShareConvAllowed

        public void setShareConvAllowed(int shared)
                         throws javax.jms.JMSException
        Sets whether client connections can share their socket (conversation)
        Parameters:
        shared - 1 indicates that the connection is allowed to share the socket with other top-level JMS connections from the same process to the same queuemanager, provided that the channel definitions match. 0 indicates that this is not permitted.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setSparseSubscriptions

        public void setSparseSubscriptions(boolean sparse)
                            throws javax.jms.JMSException
        Sets whether sparse subscriptions are selected. A sparse subscription is one that receives infrequent matching messages.
        Parameters:
        sparse - true indicates that sparse subscriptions are selected. This might be required if an application using sparse subscriptions fails to receive messages because of log overflow. If you set the attribute to true , the application must be able to open the consumer queue for browsing messages. The default value of this attribute is false .
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setSSLCertStores

        public void setSSLCertStores(java.util.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.

        Parameters:
        stores - the CRL - a list of CertStore objects which contain certificates that have been revoked. Null (the default) means that no checking of the queue manager's certificate is performed.

      • setSSLCertStores

        public void setSSLCertStores(java.lang.String stores)
                      throws javax.jms.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.
        Parameters:
        stores - this String must consist of a sequence of space-delimited LDAP URIs of the form ldap://host[:port]. If no port is specified, the LDAP default of 389 is assumed. If set to null (the default), no checking of the queue manager's certificate is performed.
        Throws:
        javax.jms.JMSException - if the ConnectionFactory supplied list of LDAP URIs is not valid.
        See Also:
        setSSLCertStores(Collection)

      • setSSLCipherSuite

        public void setSSLCipherSuite(java.lang.String cipherSuite)
        Sets the CipherSuite used for SSL encryption. Set this to the CipherSuite matching the CipherSpec set on the SVRCONN channel.
        Parameters:
        cipherSuite - the CipherSuite used for SSL encryption. If set to null (the default), no SSL encryption is performed.

      • setSSLFipsRequired

        public void setSSLFipsRequired(boolean required)
        Sets whether sslFips (FIPS) is required.
        Parameters:
        required - true indicates FIPS is required.

      • setSSLPeerName

        public void setSSLPeerName(java.lang.String peerName)
                    throws javax.jms.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.
        Parameters:
        peerName - the DN pattern. If set to null (the default), no checking of the queue manager's DN pattern is performed. This property is ignored if sslCipherSuite is null.
        Throws:
        javax.jms.JMSException - if the supplied pattern is not valid.

      • setSSLResetCount

        public void setSSLResetCount(int bytes)
                      throws javax.jms.JMSException
        Sets the SSL reset count.
        Parameters:
        bytes - the reset count. This must be an integer, with a value between 0 (disabled) and 999 999 999.
        Throws:
        javax.jms.JMSException - if bytes is not within the valid range.

      • setSSLSocketFactory

        public void setSSLSocketFactory(java.lang.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.
        Parameters:
        sf - the SSLSocketFactory object. If set to null (default), the JSSE default SSLSocketFactory is used when SSL encryption is requested. This property is ignored if sslCipherSuite is null.

      • setStatusRefreshInterval

        public void setStatusRefreshInterval(int interval)
                              throws javax.jms.JMSException
        Sets the status refresh interval.
        Parameters:
        interval - the time between transactions to refresh publish/subscribe status (milliseconds).
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setSyncpointAllGets

        public void setSyncpointAllGets(boolean flag)
        Chooses whether to do all GET operations within a syncpoint. The default setting for this property is false .
        Parameters:
        flag - true means that all GETs are to be done under syncpoint. The default is false which allows GET operations that are not under transaction management to perform more quickly.

      • setTargetClientMatching

        public void setTargetClientMatching(boolean matchClient)
        Enables or disables 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 ProviderDestination constructed with targetClient set to WMQConstants.WMQ_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.

        Parameters:
        matchClient - a boolean indicating whether to enable or disable target client matching.

      • setTemporaryModel

        public void setTemporaryModel(java.lang.String queueName)
                       throws javax.jms.JMSException
        Sets the name of an IBM MQ model queue used when creating JMS temporary destinations.
        Parameters:
        queueName - the name of the IBM MQ model queue. If refers to a model queue that can be used to create a permanent dynamic queue then you must call the MQTemporaryQueue.delete() method to destroy the queue after use.

        Within the WebSphere Application Server, MQTemporaryQueue.delete() will be called by the application server when a connection is being closed. Therefore even if a permanent dynamic model queue is used, the created temporary queue will be destroyed.

        Throws:
        javax.jms.JMSException - if queueName is either null or too long.

      • setTempTopicPrefix

        public void setTempTopicPrefix(java.lang.String prefix)
                        throws javax.jms.JMSException
        Sets the prefix to use when creating temporary topic names.
        Parameters:
        prefix - property applicable to all instances of ConnectionFactory, TopicConnectionFactory and their XA equivalents. When creating Temporary Topics, JMS will generate a Topic string of the form TEMP/prefix/<unique id>, or if this property is left with the default value, just TEMP/<unique id>.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setTempQPrefix

        public void setTempQPrefix(java.lang.String newTempQPrefix)
                    throws javax.jms.JMSException
        Sets the prefix to be used to form the name of an IBM MQ dynamic queue.
        Parameters:
        newTempQPrefix - the prefix to be used to form the name of an IBM MQ dynamic queue. This must end with the '*' character.
        Throws:
        javax.jms.JMSException - if the string is null, empty, greater than 33 characters in length, consists solely of a single character, or ends with a character other than '*'.

      • setTransportType

        public void setTransportType(int type)
                      throws javax.jms.JMSException
        Sets the transport type.
        Parameters:
        type - the transport type. Valid types are:
        Throws:
        javax.jms.JMSException - if the transport is not one of the above.

      • setUseConnectionPooling

        public void setUseConnectionPooling(boolean usePooling)
        Deprecated. JMS does not use connection pooling anymore. Any connection pooling should be done using the facilities provided by the App Server.
        Set the use of ConnectionPooling in earlier versions of the IBM MQ classes for JMS. This method is retained for compatibility with older MQJMS applications, but, because this Connection Pooling functionality has been removed from version 7, setting this property will have no effect.
        Parameters:
        usePooling - true sets the useConnectionPooling property.

      • setWildcardFormat

        public void setWildcardFormat(int format)
                       throws javax.jms.JMSException
        Sets the formatting to accept when using wildcards.
        Parameters:
        format - property applicable to all instances of ConnectionFactory, TopicConnectionFactory and their XA equivalents. In the v6 implementation, where publish/subscribe messaging is performed via a broker, different topic wildcard syntax is used depending on which broker is used. In v7, using native publish/subscribe within the queue manager, the wildcard syntax can be chosen via this property.
        Throws:
        javax.jms.JMSException - if an internal error occurs.

      • setAppName

        public void setAppName(java.lang.String name)
                throws javax.jms.JMSException
        Set the application name on the connection factory
        Parameters:
        name -
        Throws:
        javax.jms.JMSException

      • setAsyncExceptions

        public void setAsyncExceptions(int flags)
                        throws javax.jms.JMSException
        Sets the exception types that should be passed to the user's exception listener.
        Parameters:
        flags - the ASYNC_EXCEPTIONS_* filter options
        Throws:
        javax.jms.JMSException

      • createConnection

        public javax.jms.Connection createConnection()
                                      throws javax.jms.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.

        Note that the application process ID is used as the default user identity to be passed to the queue manager. If the application is running in client transport mode then this process ID must exist with the relevant authorizations on the server machine. If a different identity is required, then the application should use the createConnection(username, password) method.

        Specified by:
        createConnection in interface javax.jms.ConnectionFactory
        Overrides:
        createConnection in class com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
        Returns:
        a newly created connection.
        Throws:
        javax.jms.JMSException - if the JMS provider fails to create the connection due to some internal error.
        javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

      • createConnection

        public javax.jms.Connection createConnection(java.lang.String userID,
                                             java.lang.String password)
                                      throws javax.jms.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.
        Specified by:
        createConnection in interface javax.jms.ConnectionFactory
        Overrides:
        createConnection in class com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
        Parameters:
        userID - the caller's user identity.
        password - the caller's password.
        Returns:
        a newly created connection.
        Throws:
        javax.jms.JMSException - if the JMS provider fails to create the connection due to some internal error.
        javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

      • getClientReconnectOptions

        public int getClientReconnectOptions()
                              throws javax.jms.JMSException
        Get the client reconnection options
        Returns:
        The client reconnection options
        Throws:
        javax.jms.JMSException - If the reconnection options cannot be retrieved

      • setClientReconnectOptions

        public void setClientReconnectOptions(int options)
                               throws javax.jms.JMSException
        Specifies the client reconnect options for new connections created by this factory. These can be found in WMQConstants, and will be one of:
        • WMQ_CLIENT_RECONNECT_AS_DEF (default) - Use the value specified in the mqclient.ini file. This is set using the 'DefRecon' property within the 'Channels' stanza. It can be set to one of:
          • YES - behaves as the WMQ_CLIENT_RECONNECT option
          • NO - default. Does not specify any reconnection options
          • QMGR - behaves as the WMQ_CLIENT_RECONNECT_Q_MGR option
          • DISABLED - behaves as the WMQ_CLIENT_RECONNECT_DISABLED option
        • WMQ_CLIENT_RECONNECT - Reconnect to the any of the queue managers specified in the connection name list
        • WMQ_CLIENT_RECONNECT_Q_MGR - Reconnect to the same queue manager we were originally connected to. This will throw MQRC_RECONNECT_QMID_MISMATCH if the queue manager it tries to connect to (specified in the connection name list) has a different QMID to the queue manager originally connected to.
        • WMQ_CLIENT_RECONNECT_DISABLED - Reconnection is disabled
        Parameters:
        options - New reconnection options
        Throws:
        javax.jms.JMSException - If the reconnection options cannot be set

      • getConnectionNameList

        public java.lang.String getConnectionNameList()
                                       throws javax.jms.JMSException
        Get the hosts to which the client will attempt to connect to
        Returns:
        The client hosts to which the client will attempt to connect
        Throws:
        javax.jms.JMSException - If the connection name list cannot be retrieved

      • setConnectionNameList

        public void setConnectionNameList(java.lang.String hosts)
                           throws javax.jms.JMSException
        Specifies the hosts to which the client will attempt to reconnect to after its connection is broken. The connection name list is a comma seperated list of host/ip port pairs.

        eg. 127.0.0.1(1414),host2.example.com(1400) The default setting of this property is 'localhost(1414)' A null, or empty string is taken to mean localhost(1414)

        Parameters:
        hosts - The hosts to connect to
        Throws:
        javax.jms.JMSException - If the connection name list cannot be set

      • getClientReconnectTimeout

        public int getClientReconnectTimeout()
                              throws javax.jms.JMSException
        Get the amount of time, in seconds, that a client connection will attempt to reconnect.
        Returns:
        the amount of time, in seconds, that a client connection will attempt to reconnect
        Throws:
        javax.jms.JMSException - if the reconnection timeout cannot be retrieved

      • setClientReconnectTimeout

        public void setClientReconnectTimeout(int timeout)
                               throws javax.jms.JMSException
        Set the amount of time, in seconds, that a client connection will attempt to reconnect. After attempting to reconnect for this amount of time, the client will fail with MQRC_RECONNECT_FAILED. The default setting for this property is WMQConstants.WMQ_CLIENT_RECONNECT_TIMEOUT_DEFAULT.
        Parameters:
        timeout - is the time in seconds to reconnect
        Throws:
        javax.jms.JMSException - if the reconnection timeout cannot be set
Skip navigation links
(c) Copyright IBM Corp. 2008, 2016. All Rights Reserved.