com.ibm.mq.jms

Class MQConnectionFactory

  1. java.lang.Object
  2. extended bycom.ibm.msg.client.jms.internal.JmsReadablePropertyContextImpl
  3. extended bycom.ibm.msg.client.jms.internal.JmsPropertyContextImpl
  4. extended bycom.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
  5. extended bycom.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
  6. extended bycom.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
  1. public class MQConnectionFactory
  2. extends com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
MQConnectionFactory is the WebSphere 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 specifies a null or blank user identity when creating a connection, then the User ID that started the JVM (including application servers) will be sent to the queue manager for authentication.

See Also:
Connection, QueueConnectionFactory, TopicConnectionFactory, Serialized Form

Nested Class Summary

Modifier and Type Class and Description
  1. 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

Constructor and Description
MQConnectionFactory()
Default constructor.

Method Summary

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

  1. void
 setClientID(java.lang.String id)
Sets the client ID.
  1. void
 setClientReconnectOptions(int options)
Specifies the client reconnect options for new connections created by this factory.
  1. void
 setClientReconnectTimeout(int timeout)
Set the amount of time, in seconds, that a client connection will attempt to reconnect.
  1. void
 setConnectionNameList(java.lang.String hosts)
Specifies the hosts to which the client will attempt to reconnect to after its connection is broken.
  1. void
 setConnTag(byte[] cTag)
Sets the value of the queue manager connection tag.
  1. void
 setDescription(java.lang.String desc)
Sets the description.
  1. void
 setDirectAuth(int authority)
Sets the type of direct authentication that is required.
  1. void
 setFailIfQuiesce(int fiq)
Sets the default behavior of applications accessing a quiescing queue manager.
  1. void
 setHdrCompList(java.util.Collection<?> compList)
Sets the list of header compression techniques.
  1. void
 setHostName(java.lang.String hostname)
Sets the name of the host.
  1. void
 setLocalAddress(java.lang.String address)
Sets the local address.
  1. void
 setMapNameStyle(boolean style)
Allows compatibility style to be used for map message element names.
  1. void
 setMaxBufferSize(int size)
Sets the maximum buffer size.
  1. void
 setMessageRetention(int mRet)
Sets what happens to unwanted messages.
  1. void
 setMessageSelection(int selection)
Sets whether the client or the broker performs message selection.
  1. void
 setMQConnectionOptions(int cTagOpt)
Sets the connection options for a queue manager.
  1. void
 setMsgBatchSize(int size)
Sets the message batch size.
  1. void
 setMsgCompList(java.util.Collection<?> compList)
Sets the list of message compression techniques.
  1. void
 setMulticast(int multicast)
Deprecated.
  1. void
 setOptimisticPublication(boolean newVal)
Deprecated.
  1. void
 setOutcomeNotification(boolean newVal)
Deprecated.
  1. void
 setPollingInterval(int interval)
Sets the interval between scans of all receivers during asynchronous message delivery.
  1. void
 setPort(int port)
Sets the port for a client connection.
  1. void
 setProcessDuration(int newVal)
Deprecated.
  1. void
 setProviderVersion(java.lang.String version)
Sets the provider version that should be used when creating connections.
  1. void
 setProxyHostName(java.lang.String hostName)
Sets the proxy host name.
  1. void
 setProxyPort(int proxyPort)
Sets the proxy port attribute.
  1. void
 setPubAckInterval(int interval)
Sets the number of messages that can be published before requiring acknowledgement from the broker.
  1. void
 setQueueManager(java.lang.String queueManagerName)
Sets the name of the queue manager.
  1. void
 setReceiveExit(java.lang.String receiveExit)
Sets the receive exit.
  1. void
 setReceiveExitInit(java.lang.String data)
Sets the initialization string for the receive exit.
  1. void
 setReceiveIsolation(int newVal)
Deprecated.
  1. void
 setRescanInterval(int interval)
Sets the interval between browsing a queue.
  1. void
 setSecurityExit(java.lang.String securityExit)
Sets the security exit.
  1. void
 setSecurityExitInit(java.lang.String data)
Sets the initialization string for the security exit.
  1. void
 setSendCheckCount(int interval)
Sets the interval between send calls to check for errors on asynchronous put.
  1. void
 setSendExit(java.lang.String sendExit)
Sets the send exit.
  1. void
 setSendExitInit(java.lang.String data)
Gets the description of the send exit.
  1. void
 setShareConvAllowed(int shared)
Sets whether client connections can share their socket (conversation)
  1. void
 setSparseSubscriptions(boolean sparse)
Sets whether sparse subscriptions are selected.
  1. void
 setSSLCertStores(java.util.Collection<?> stores)
Provides a collection of CertStore objects used for certificate revocation list (CRL) checking.
  1. void
 setSSLCertStores(java.lang.String stores)
Specifies a list of LDAP servers used for certificate revocation list (CRL) checking.
  1. void
 setSSLCipherSuite(java.lang.String cipherSuite)
Sets the CipherSuite used for SSL encryption.
  1. void
 setSSLFipsRequired(boolean required)
Sets whether sslFips (FIPS) is required.
  1. void
 setSSLPeerName(java.lang.String peerName)
Sets a distinguished name (DN) pattern.
  1. void
 setSSLResetCount(int bytes)
Sets the SSL reset count.
  1. void
 setSSLSocketFactory(java.lang.Object sf)
Sets the SSLSocketFactory for use with SSL encryption.
  1. void
 setStatusRefreshInterval(int interval)
Sets the status refresh interval.
  1. void
 setSubscriptionStore(int flag)
Sets the SUBSTORE property.
  1. void
 setSyncpointAllGets(boolean flag)
Chooses whether to do all GET operations within a syncpoint.
  1. void
 setTargetClientMatching(boolean matchClient)
Enables or disables target client matching.
  1. void
 setTemporaryModel(java.lang.String queueName)
Sets the name of a WebSphere MQ model queue used when creating JMS temporary destinations.
  1. void
 setTempQPrefix(java.lang.String newTempQPrefix)
Sets the prefix to be used to form the name of a WebSphere MQ dynamic queue.
  1. void
 setTempTopicPrefix(java.lang.String prefix)
Sets the prefix to use when creating temporary topic names.
  1. void
 setTransportType(int type)
Sets the transport type.
  1. 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.
  1. void
 setWildcardFormat(int format)
Sets the formatting to accept when using wildcards.
Methods inherited from class com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
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
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 com.ibm.msg.client.jms.JmsPropertyContext
setBatchProperties, setBooleanProperty, setByteProperty, setBytesProperty, setCharProperty, setDoubleProperty, setFloatProperty, setIntProperty, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
Methods inherited from interface com.ibm.msg.client.jms.JmsReadablePropertyContext
getBooleanProperty, getByteProperty, getBytesProperty, getCharProperty, getDoubleProperty, getFloatProperty, getIntProperty, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

MQConnectionFactory

  1. public MQConnectionFactory()
Default constructor.

Method Detail

getBrokerCCSubQueue

  1. public java.lang.String getBrokerCCSubQueue( )
  2. 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

  1. public java.lang.String getBrokerControlQueue( )
  2. 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

  1. public java.lang.String getBrokerPubQueue( )
  2. 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

  1. public java.lang.String getBrokerQueueManager( )
  2. 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

  1. public java.lang.String getBrokerSubQueue( )
  2. 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

  1. public int getBrokerVersion()
  2. 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

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

getCCSID

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

getChannel

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

getCleanupInterval

  1. public long getCleanupInterval( )
  2. 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

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

getClientID

  1. 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

  1. @Deprecated
  2. 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

  1. 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

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

getDirectAuth

  1. public int getDirectAuth()
  2. throws javax.jms.JMSException
Gets the type of direct authentication that is required.
Returns:
one of the following:
Throws:
javax.jms.JMSException - if an internal error occurs.

getFailIfQuiesce

  1. public int getFailIfQuiesce()
Indicates the default behavior of applications accessing a quiescing queue manager.
Returns:
possible values are:

getHdrCompList

  1. 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

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

getLocalAddress

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

getMapNameStyle

  1. public boolean getMapNameStyle( )
Allows compatibility style to be used for map message element names.
Returns:
possible values are:

getMaxBufferSize

  1. public int getMaxBufferSize()
  2. 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

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

getMessageSelection

  1. public int getMessageSelection( )
  2. 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

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

getMsgBatchSize

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

getMsgCompList

  1. public java.util.Collection 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

getMsgCompListAsString

  1. public java.lang.String getMsgCompListAsString( )
Returns:
The String instance representing the list of message compressors. The first item in the list represents the current message compressor.
exclude
Gets the message compression list as a String. This is required for the JMS admin tool.

getMulticast

  1. public int getMulticast()
  2. throws javax.jms.JMSException
Deprecated.
Gets the value of the multicast attribute.
Returns:
the following values are possible:
Throws:
javax.jms.JMSException - if an internal error occurs.

getOptimisticPublication

  1. @Deprecated
  2. public boolean getOptimisticPublication( )
  3. throws javax.jms.JMSException
Deprecated.
Returns:
the indicator
Throws:
javax.jms.JMSException
exclude
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.

getOutcomeNotification

  1. @Deprecated
  2. public boolean getOutcomeNotification( )
  3. throws javax.jms.JMSException
Deprecated.
Returns:
true if MessageConsumers are informed or false if not.
Throws:
javax.jms.JMSException
exclude
Indicates whether the publish/subscribe MessageConsumers are informed of the outcome of acknowledge or commit calls after receiving messages.

getPollingInterval

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

getPort

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

getProcessDuration

  1. @Deprecated
  2. public int getProcessDuration( )
  3. throws javax.jms.JMSException
Deprecated.
Returns:
the process duration (milliseconds).
Throws:
javax.jms.JMSException
exclude
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.

getProviderVersion

  1. public java.lang.String getProviderVersion( )
  2. 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

  1. public java.lang.String getProxyHostName( )
  2. throws javax.jms.JMSException
Gets the proxy host name.
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

  1. public int getProxyPort()
  2. 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

  1. public int getPubAckInterval()
  2. 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

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

getReceiveExit

  1. 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

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

getReceiveIsolation

  1. @Deprecated
  2. public int getReceiveIsolation( )
  3. throws javax.jms.JMSException
Deprecated.
Returns:
one of these values:
  • WMQConstants.WMQ_RCVISOL_COMMITTED
  • WMQConstants.WMQ_RCVISOL_UNCOMMITTED
Throws:
javax.jms.JMSException
exclude
Indicates whether calls by MessageConsumers are isolated from other operations.

getReference

  1. public javax.naming.Reference getReference( )
  2. 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

  1. 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

  1. 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

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

getSendCheckCount

  1. public int getSendCheckCount()
  2. 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

  1. 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

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

getShareConvAllowed

  1. public int getShareConvAllowed( )
  2. 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

  1. public boolean getSparseSubscriptions( )
  2. 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

  1. public java.util.Collection getSSLCertStores( )
  2. 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

  1. public java.lang.String getSSLCertStoresAsString( )
  2. 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

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

getSSLFipsRequired

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

getSSLPeerName

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

getSSLResetCount

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

getSSLSocketFactory

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

getStatusRefreshInterval

  1. public int getStatusRefreshInterval( )
  2. 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.

getSubscriptionStore

  1. public int getSubscriptionStore( )
  2. throws javax.jms.JMSException
Gets the SUBSTORE property.
Returns:
an integer which represents a valid values of the SUBSTORE property:
Throws:
javax.jms.JMSException - if an internal error occurs.

getSyncpointAllGets

  1. 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

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

getTemporaryModel

  1. public java.lang.String getTemporaryModel( )
  2. 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

  1. public java.lang.String getTempTopicPrefix( )
  2. 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

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

getTransportType

  1. public int getTransportType()
Gets the transport type.
Returns:
the transport type. Valid types are:

getUseConnectionPooling

  1. @Deprecated
  2. public boolean getUseConnectionPooling( )
Deprecated. as noted in setUseConnectionPooling(boolean usePooling) this property has no effect in the current release
Indicates whether the useConnectionPooling property has been set.
Returns:
true means that useConnectionPooling property has been set for this object.
See Also:
setUseConnectionPooling(boolean usePooling)

getVersion

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

getWildcardFormat

  1. public int getWildcardFormat()
  2. 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

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

getAsyncExceptions

  1. 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

  1. public void setBrokerCCSubQueue( java.lang.String queueName)
  2. 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

  1. public void setBrokerControlQueue( java.lang.String queueName)
  2. 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

  1. public void setBrokerPubQueue(java.lang.String queueName)
  2. 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

  1. public void setBrokerQueueManager( java.lang.String queueManagerName)
  2. 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

  1. public void setBrokerSubQueue(java.lang.String queueName)
  2. throws javax.jms.JMSException
Gets 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.

setBrokerVersion

  1. public void setBrokerVersion(int version)
  2. throws javax.jms.JMSException
Sets the version of the broker.
Parameters:
version - possible values are:
Throws:
javax.jms.JMSException - if version is invalid.

setCCDTURL

  1. 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

  1. public void setCCSID(int ccsid)
  2. 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

  1. public void setChannel(java.lang.String channelName)
  2. 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

  1. public void setCleanupInterval( long interval)
  2. 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.

setCleanupLevel

  1. public void setCleanupLevel(int level)
  2. throws javax.jms.JMSException
Sets the clean up level.
Parameters:
level - permitted levels are:
Throws:
javax.jms.JMSException - if level is not as listed above.

setClientID

  1. 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

  1. @Deprecated
  2. 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

  1. 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

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

setDirectAuth

  1. public void setDirectAuth(int authority)
  2. throws javax.jms.JMSException
Sets the type of direct authentication that is required.
Parameters:
authority - one of the following:
Throws:
javax.jms.JMSException - if authority is neither of the above.

setFailIfQuiesce

  1. public void setFailIfQuiesce(int fiq)
  2. 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

  1. public void setHdrCompList(java.util.Collection<?> compList)
  2. 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

  1. 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 WebSphere MQ.
Parameters:
hostname - the name of the host.

setLocalAddress

  1. public void setLocalAddress(java.lang.String address)
  2. 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.

setMapNameStyle

  1. public void setMapNameStyle(boolean style)
Allows compatibility style to be used for map message element names.
Parameters:
style - possible values are:

setMaxBufferSize

  1. public void setMaxBufferSize(int size)
  2. 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

  1. public void setMessageRetention( int mRet)
  2. 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

  1. public void setMessageSelection( int selection)
  2. 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

  1. public void setMQConnectionOptions( int cTagOpt)
  2. 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

  1. public void setMsgBatchSize(int size)
  2. 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

  1. public void setMsgCompList(java.util.Collection<?> compList)
  2. 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

  1. public void setMulticast(int multicast)
  2. throws javax.jms.JMSException
Deprecated.
Sets the value of the multicast attribute.
Parameters:
multicast - the following values are possible:
Throws:
javax.jms.JMSException - if multicast does not belong to the above.

setOptimisticPublication

  1. @Deprecated
  2. public void setOptimisticPublication( boolean newVal)
  3. throws javax.jms.JMSException
Deprecated.
Parameters:
newVal - true requires the ProviderMessageProducer to wait until the message has completed delivery false allows the send() or publish() method to return more promptly . This is particularly useful if a ProviderMessageConsumer might be receiving uncommitted messages, however it does mean that the ProviderMessageProducer will not be informed of a delivery failure until it attempts to commit its sent messages.
Throws:
javax.jms.JMSException
exclude
Determines whether the publish/subscribe message producers 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.

setOutcomeNotification

  1. @Deprecated
  2. public void setOutcomeNotification( boolean newVal)
  3. throws javax.jms.JMSException
Deprecated.
Parameters:
newVal - true if MessageConsumers are to be informed, false if not.
Throws:
javax.jms.JMSException
exclude
Determines whether publish/subscribe MessageConsumers are informed of the outcome of acknowledge or commit calls after receiving messages.

setPollingInterval

  1. public void setPollingInterval( int interval)
  2. 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

  1. public void setPort(int port)
  2. 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.

setProcessDuration

  1. @Deprecated
  2. public void setProcessDuration( int newVal)
  3. throws javax.jms.JMSException
Deprecated.
Parameters:
newVal - the process duration (milliseconds).
Throws:
javax.jms.JMSException
exclude
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.

setProviderVersion

  1. public void setProviderVersion( java.lang.String version)
  2. 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

  1. public void setProxyHostName(java.lang.String hostName)
  2. throws javax.jms.JMSException
Sets the proxy host name.
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

  1. public void setProxyPort(int proxyPort)
  2. throws javax.jms.JMSException
Sets the proxy port attribute.
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

  1. public void setPubAckInterval(int interval)
  2. 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

  1. public void setQueueManager(java.lang.String queueManagerName)
  2. 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 '*'.
  • "*" or "" or a name which consists entirely of blanks is used. The actual queue manager name is disregarded when a channel definition is being selected.
    • Throws:
    javax.jms.JMSException - if queueManagerName is either null or too long.

    setReceiveExit

    1. public void setReceiveExit(java.lang.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.
    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

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

    setReceiveIsolation

    1. @Deprecated
    2. public void setReceiveIsolation( int newVal)
    3. throws javax.jms.JMSException
    Deprecated.
    Parameters:
    newVal - one of these values:
    • WMQConstants.WMQ_RCVISOL_COMMITTED
    • WMQConstants.WMQ_RCVISOL_UNCOMMITTED
    Throws:
    javax.jms.JMSException
    exclude
    Sets whether calls by MessageConsumers are isolated from other operations.

    setRescanInterval

    1. public void setRescanInterval(int interval)
    2. 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

    1. public void setSecurityExit(java.lang.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.
    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

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

    setSendCheckCount

    1. public void setSendCheckCount(int interval)
    2. 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

    1. public void setSendExit(java.lang.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.
    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

    1. 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

    1. public void setShareConvAllowed( int shared)
    2. 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

    1. public void setSparseSubscriptions( boolean sparse)
    2. 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

    1. 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

    1. public void setSSLCertStores(java.lang.String stores)
    2. 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

    1. 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

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

    setSSLPeerName

    1. public void setSSLPeerName(java.lang.String peerName)
    2. 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

    1. public void setSSLResetCount(int bytes)
    2. 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

    1. 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

    1. public void setStatusRefreshInterval( int interval)
    2. 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.

    setSubscriptionStore

    1. public void setSubscriptionStore( int flag)
    2. throws javax.jms.JMSException
    Sets the SUBSTORE property.
    Parameters:
    flag - an integer which represents a valid values of the SUBSTORE property:
    Throws:
    javax.jms.JMSException - if flag is not one of the above.

    setSyncpointAllGets

    1. 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

    1. 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

    1. public void setTemporaryModel(java.lang.String queueName)
    2. throws javax.jms.JMSException
    Sets the name of a WebSphere MQ model queue used when creating JMS temporary destinations.
    Parameters:
    queueName - the name of the WebSphere 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

    1. public void setTempTopicPrefix( java.lang.String prefix)
    2. 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

    1. public void setTempQPrefix(java.lang.String newTempQPrefix)
    2. throws javax.jms.JMSException
    Sets the prefix to be used to form the name of a WebSphere MQ dynamic queue.
    Parameters:
    newTempQPrefix - the prefix to be used to form the name of a WebSphere 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

    1. public void setTransportType(int type)
    2. 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

    1. @Deprecated
    2. 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 WebSphere 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

    1. public void setWildcardFormat(int format)
    2. 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

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

    setAsyncExceptions

    1. public void setAsyncExceptions( int flags)
    2. 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

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

    1. public javax.jms.Connection createConnection( java.lang.String userID,
    2. java.lang.String password)
    3. 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

    1. public int getClientReconnectOptions( )
    2. 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

    1. public void setClientReconnectOptions( int options)
    2. 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

    1. public java.lang.String getConnectionNameList( )
    2. 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

    1. public void setConnectionNameList( java.lang.String hosts)
    2. 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)'

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

    getClientReconnectTimeout

    1. public int getClientReconnectTimeout( )
    2. 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

    1. public void setClientReconnectTimeout( int timeout)
    2. 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