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
- public class MQConnectionFactory
- extends com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
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.
Nested Class Summary
Modifier and Type | Class and Description |
---|---|
|
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 |
---|---|
|
createConnection()
Creates a connection with the default user identity.
|
|
createConnection(java.lang.String userID,java.lang.String password)
Creates a connection with the specified user identity.
|
|
getAppName()
|
|
getAsyncExceptions()
Gets the exception types that will be passed to the user's async exception listener
|
|
getBrokerCCSubQueue()
Gets the broker's queue name for nondurable connection consumers.
|
|
getBrokerControlQueue()
Gets the broker's control queue name.
|
|
getBrokerPubQueue()
Gets the broker's publish queue name.
|
|
getBrokerQueueManager()
Gets the name of the broker's queue manager.
|
|
getBrokerSubQueue()
Gets the broker's queue name for subscribers.
|
|
getBrokerVersion()
Gets the version number of the broker.
|
|
getCCDTURL()
Gets the URL for the client channel definition table.
|
|
getCCSID()
Gets the character set of the queue manager.
|
|
getChannel()
Gets the name of the channel that was used.
|
|
getCleanupInterval()
Gets the clean up interval.
|
|
getCleanupLevel()
Gets the clean up level.
|
|
getClientId()
Deprecated. Gets the client ID.
|
|
getClientID()
Gets the client ID.
|
|
getClientReconnectOptions()
Get the client reconnection options
|
|
getClientReconnectTimeout()
Get the amount of time, in seconds, that a client connection will attempt to reconnect.
|
|
getConnectionNameList()
Get the hosts to which the client will attempt to connect to
|
|
getConnTag()
Gets the value of the queue manager connection tag.
|
|
getDescription()
Gets the description.
|
|
getDirectAuth()
Gets the type of direct authentication that is required.
|
|
getFailIfQuiesce()
Indicates the default behavior of applications accessing a quiescing queue manager.
|
|
getHdrCompList()
Gets the list of header compression techniques which has been set.
|
|
getHostName()
Gets the name of the host.
|
|
getLocalAddress()
Gets the local address.
|
|
getMapNameStyle()
Allows compatibility style to be used for map message element names.
|
|
getMaxBufferSize()
Gets the maximum buffer size.
|
|
getMessageRetention()
Indicates what happens to unwanted messages.
|
|
getMessageSelection()
Indicates whether the client or the broker performs message selection.
|
|
getMQConnectionOptions()
Gets the connection options.
|
|
getMsgBatchSize()
Gets the message batch size.
|
|
getMsgCompList()
Gets the list of message compression techniques that have been set.
|
|
getMsgCompListAsString()
|
|
getMulticast()
Deprecated.
|
|
getOptimisticPublication()
Deprecated.
|
|
getOutcomeNotification()
Deprecated.
|
|
getPollingInterval()
Gets the interval between scans of all receivers during asynchronous message delivery.
|
|
getPort()
Gets the port number.
|
|
getProcessDuration()
Deprecated.
|
|
getProviderVersion()
Gets the provider version that should be used when creating connections.
|
|
getProxyHostName()
Gets the proxy host name.
|
|
getProxyPort()
Gets the port number of the proxy server.
|
|
getPubAckInterval()
Gets the number of messages that can be published before requiring acknowledgement from the
broker.
|
|
getQueueManager()
Gets the name of the queue manager.
|
|
getReceiveExit()
Gets the description of the receive exit.
|
|
getReceiveExitInit()
Gets the initialization string for the receive exit.
|
|
getReceiveIsolation()
Deprecated.
|
|
getReference()
Creates a reference for this queue connection factory.
|
|
getRescanInterval()
Gets the interval between browse scans of a queue.
|
|
getSecurityExit()
Gets the description of the security exit.
|
|
getSecurityExitInit()
Gets the initialization string for the security exit.
|
|
getSendCheckCount()
Gets the interval between send calls to check for errors on asynchronous put.
|
|
getSendExit()
Gets the description of the send exit.
|
|
getSendExitInit()
Gets the initialization string for the send exit.
|
|
getShareConvAllowed()
Gets a value indicating whether client connections are sharing their socket (conversation)
|
|
getSparseSubscriptions()
Gets the sparse subscriptions attribute.
|
|
getSSLCertStores()
Gets the collection of CertStore objects.
|
|
getSSLCertStoresAsString()
Gets the collection of CertStore objects as a String.
|
|
getSSLCipherSuite()
Gets the CipherSuite used for SSL encryption.
|
|
getSSLFipsRequired()
Indicates whether sslFips (FIPS) is required.
|
|
getSSLPeerName()
Gets the distinguished name pattern used to validate the queue manager.
|
|
getSSLResetCount()
Gets the SSL reset count.
|
|
getSSLSocketFactory()
Gets the SSLSocketFactory used with SSL encryption.
|
|
getStatusRefreshInterval()
Gets the status refresh interval.
|
|
getSubscriptionStore()
Gets the SUBSTORE property.
|
|
getSyncpointAllGets()
Indicates how syncpoint is used for GET operations.
|
|
getTargetClientMatching()
is target client matching enabled.
|
|
getTemporaryModel()
Gets the name of a model queue for creating temporary destinations.
|
|
getTempQPrefix()
Gets the prefix used to form the name of a WebSphere MQ dynamic queue.
|
|
getTempTopicPrefix()
Gets the prefix to use when creating temporary topic names.
|
|
getTransportType()
Gets the transport type.
|
|
getUseConnectionPooling()
Deprecated. as noted in
setUseConnectionPooling(boolean usePooling)
this property has no effect in the current release
|
|
getVersion()
Gets the version number.
|
|
getWildcardFormat()
Gets the formatting accepted when using wildcards.
|
|
setAppName(java.lang.String name)
Set the application name on the connection factory
|
|
setAsyncExceptions(int flags)
Sets the exception types that should be passed to the user's exception listener.
|
|
setBrokerCCSubQueue(java.lang.String queueName)
Sets the name of the broker nondurable connection consumer subscriber queue.
|
|
setBrokerControlQueue(java.lang.String queueName)
Sets the name of the broker control queue.
|
|
setBrokerPubQueue(java.lang.String queueName)
Sets the name of the broker's publish queue.
|
|
setBrokerQueueManager(java.lang.String queueManagerName)
Sets the name of the broker's queue manager.
|
|
setBrokerSubQueue(java.lang.String queueName)
Gets the name of the broker nondurable subscriber queue.
|
|
setBrokerVersion(int version)
Sets the version of the broker.
|
|
setCCDTURL(java.net.URL url)
Sets the URL for the client channel definition table.
|
|
setCCSID(int ccsid)
Sets the character set to be used when connecting to the queue manager.
|
|
setChannel(java.lang.String channelName)
Sets the name of the channel - applies to client transport mode only.
|
|
setCleanupInterval(long interval)
Sets the clean up interval.
|
|
setCleanupLevel(int level)
Sets the clean up level.
|
|
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. |
|
setClientID(java.lang.String id)
Sets the client ID.
|
|
setClientReconnectOptions(int options)
Specifies the client reconnect options for new connections created by this factory.
|
|
setClientReconnectTimeout(int timeout)
Set the amount of time, in seconds, that a client connection will attempt to reconnect.
|
|
setConnectionNameList(java.lang.String hosts)
Specifies the hosts to which the client will attempt to reconnect to after its connection is
broken.
|
|
setConnTag(byte[] cTag)
Sets the value of the queue manager connection tag.
|
|
setDescription(java.lang.String desc)
Sets the description.
|
|
setDirectAuth(int authority)
Sets the type of direct authentication that is required.
|
|
setFailIfQuiesce(int fiq)
Sets the default behavior of applications accessing a quiescing queue manager.
|
|
setHdrCompList(java.util.Collection<?> compList)
Sets the list of header compression techniques.
|
|
setHostName(java.lang.String hostname)
Sets the name of the host.
|
|
setLocalAddress(java.lang.String address)
Sets the local address.
|
|
setMapNameStyle(boolean style)
Allows compatibility style to be used for map message element names.
|
|
setMaxBufferSize(int size)
Sets the maximum buffer size.
|
|
setMessageRetention(int mRet)
Sets what happens to unwanted messages.
|
|
setMessageSelection(int selection)
Sets whether the client or the broker performs message selection.
|
|
setMQConnectionOptions(int cTagOpt)
Sets the connection options for a queue manager.
|
|
setMsgBatchSize(int size)
Sets the message batch size.
|
|
setMsgCompList(java.util.Collection<?> compList)
Sets the list of message compression techniques.
|
|
setMulticast(int multicast)
Deprecated.
|
|
setOptimisticPublication(boolean newVal)
Deprecated.
|
|
setOutcomeNotification(boolean newVal)
Deprecated.
|
|
setPollingInterval(int interval)
Sets the interval between scans of all receivers during asynchronous message delivery.
|
|
setPort(int port)
Sets the port for a client connection.
|
|
setProcessDuration(int newVal)
Deprecated.
|
|
setProviderVersion(java.lang.String version)
Sets the provider version that should be used when creating connections.
|
|
setProxyHostName(java.lang.String hostName)
Sets the proxy host name.
|
|
setProxyPort(int proxyPort)
Sets the proxy port attribute.
|
|
setPubAckInterval(int interval)
Sets the number of messages that can be published before requiring acknowledgement from the
broker.
|
|
setQueueManager(java.lang.String queueManagerName)
Sets the name of the queue manager.
|
|
setReceiveExit(java.lang.String receiveExit)
Sets the receive exit.
|
|
setReceiveExitInit(java.lang.String data)
Sets the initialization string for the receive exit.
|
|
setReceiveIsolation(int newVal)
Deprecated.
|
|
setRescanInterval(int interval)
Sets the interval between browsing a queue.
|
|
setSecurityExit(java.lang.String securityExit)
Sets the security exit.
|
|
setSecurityExitInit(java.lang.String data)
Sets the initialization string for the security exit.
|
|
setSendCheckCount(int interval)
Sets the interval between send calls to check for errors on asynchronous put.
|
|
setSendExit(java.lang.String sendExit)
Sets the send exit.
|
|
setSendExitInit(java.lang.String data)
Gets the description of the send exit.
|
|
setShareConvAllowed(int shared)
Sets whether client connections can share their socket (conversation)
|
|
setSparseSubscriptions(boolean sparse)
Sets whether sparse subscriptions are selected.
|
|
setSSLCertStores(java.util.Collection<?> stores)
Provides a collection of CertStore objects used for certificate revocation list (CRL) checking.
|
|
setSSLCertStores(java.lang.String stores)
Specifies a list of LDAP servers used for certificate revocation list (CRL) checking.
|
|
setSSLCipherSuite(java.lang.String cipherSuite)
Sets the CipherSuite used for SSL encryption.
|
|
setSSLFipsRequired(boolean required)
Sets whether sslFips (FIPS) is required.
|
|
setSSLPeerName(java.lang.String peerName)
Sets a distinguished name (DN) pattern.
|
|
setSSLResetCount(int bytes)
Sets the SSL reset count.
|
|
setSSLSocketFactory(java.lang.Object sf)
Sets the SSLSocketFactory for use with SSL encryption.
|
|
setStatusRefreshInterval(int interval)
Sets the status refresh interval.
|
|
setSubscriptionStore(int flag)
Sets the SUBSTORE property.
|
|
setSyncpointAllGets(boolean flag)
Chooses whether to do all GET operations within a syncpoint.
|
|
setTargetClientMatching(boolean matchClient)
Enables or disables target client matching.
|
|
setTemporaryModel(java.lang.String queueName)
Sets the name of a WebSphere MQ model queue used when creating JMS temporary destinations.
|
|
setTempQPrefix(java.lang.String newTempQPrefix)
Sets the prefix to be used to form the name of a WebSphere MQ dynamic queue.
|
|
setTempTopicPrefix(java.lang.String prefix)
Sets the prefix to use when creating temporary topic names.
|
|
setTransportType(int type)
Sets the transport type.
|
|
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.
|
|
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
- public MQConnectionFactory()
Method Detail
getBrokerCCSubQueue
- public java.lang.String getBrokerCCSubQueue( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getBrokerControlQueue
- public java.lang.String getBrokerControlQueue( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getBrokerPubQueue
- public java.lang.String getBrokerPubQueue( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getBrokerQueueManager
- public java.lang.String getBrokerQueueManager( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getBrokerSubQueue
- public java.lang.String getBrokerSubQueue( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getBrokerVersion
- public int getBrokerVersion()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getCCDTURL
- public java.net.URL getCCDTURL( )
getCCSID
- public int getCCSID()
getChannel
- public java.lang.String getChannel( )
getCleanupInterval
- public long getCleanupInterval( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getCleanupLevel
- public int getCleanupLevel()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getClientID
- public java.lang.String getClientID( )
Note that this method always throws an IllegalStateException when you make a direct connection to a broker.
getClientId
- @Deprecated
- public java.lang.String getClientId( )
Note that this method always throws an IllegalStateException when you make a direct connection to a broker.
getConnTag
- public byte[] getConnTag()
getDescription
- public java.lang.String getDescription( )
getDirectAuth
- public int getDirectAuth()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getFailIfQuiesce
- public int getFailIfQuiesce()
getHdrCompList
- public java.util.Collection<java.lang.Object> getHdrCompList( )
getHostName
- public java.lang.String getHostName( )
getLocalAddress
- public java.lang.String getLocalAddress( )
getMapNameStyle
- public boolean getMapNameStyle( )
getMaxBufferSize
- public int getMaxBufferSize()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getMessageRetention
- public int getMessageRetention( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getMessageSelection
- public int getMessageSelection( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getMQConnectionOptions
- public int getMQConnectionOptions( )
getMsgBatchSize
- public int getMsgBatchSize()
getMsgCompList
- public java.util.Collection getMsgCompList( )
getMsgCompListAsString
- public java.lang.String getMsgCompListAsString( )
getMulticast
- public int getMulticast()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getOptimisticPublication
- @Deprecated
- public boolean getOptimisticPublication( )
- throws javax.jms.JMSException
javax.jms.JMSException
getOutcomeNotification
- @Deprecated
- public boolean getOutcomeNotification( )
- throws javax.jms.JMSException
javax.jms.JMSException
getPollingInterval
- public int getPollingInterval()
getPort
- public int getPort()
getProcessDuration
- @Deprecated
- public int getProcessDuration( )
- throws javax.jms.JMSException
javax.jms.JMSException
getProviderVersion
- public java.lang.String getProviderVersion( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getProxyHostName
- public java.lang.String getProxyHostName( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getProxyPort
- public int getProxyPort()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getPubAckInterval
- public int getPubAckInterval()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getQueueManager
- public java.lang.String getQueueManager( )
getReceiveExit
- public java.lang.String getReceiveExit( )
getReceiveExitInit
- public java.lang.String getReceiveExitInit( )
getReceiveIsolation
- @Deprecated
- public int getReceiveIsolation( )
- throws javax.jms.JMSException
-
WMQConstants.WMQ_RCVISOL_COMMITTED
-
WMQConstants.WMQ_RCVISOL_UNCOMMITTED
javax.jms.JMSException
getReference
- public javax.naming.Reference getReference( )
- throws javax.naming.NamingException
javax.naming.Reference
interface.
getReference
in interface javax.naming.Referenceable
getReference
in class com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl
javax.naming.NamingException
- if there is a naming problem. getRescanInterval
- public int getRescanInterval()
getSecurityExit
- public java.lang.String getSecurityExit( )
getSecurityExitInit
- public java.lang.String getSecurityExitInit( )
getSendCheckCount
- public int getSendCheckCount()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getSendExit
- public java.lang.String getSendExit( )
getSendExitInit
- public java.lang.String getSendExitInit( )
getShareConvAllowed
- public int getShareConvAllowed( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getSparseSubscriptions
- public boolean getSparseSubscriptions( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getSSLCertStores
- public java.util.Collection getSSLCertStores( )
- throws javax.jms.JMSException
setSSLCertStores(Collection)
was used to set a
collection of CertStore objects or a String specifying such a list. javax.jms.JMSException
- if an unsupported type or bad value is encountered. getSSLCertStoresAsString
- public java.lang.String getSSLCertStoresAsString( )
- throws javax.jms.JMSException
setSSLCertStores(String)
set it as a String in the
first place. javax.jms.JMSException
- if the CertStore objects were provided as a Collection. getSSLCipherSuite
- public java.lang.String getSSLCipherSuite( )
getSSLFipsRequired
- public boolean getSSLFipsRequired( )
getSSLPeerName
- public java.lang.String getSSLPeerName( )
getSSLResetCount
- public int getSSLResetCount()
getSSLSocketFactory
- public java.lang.Object getSSLSocketFactory( )
getStatusRefreshInterval
- public int getStatusRefreshInterval( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getSubscriptionStore
- public int getSubscriptionStore( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getSyncpointAllGets
- public boolean getSyncpointAllGets( )
getTargetClientMatching
- public boolean getTargetClientMatching( )
getTemporaryModel
- public java.lang.String getTemporaryModel( )
- throws javax.jms.JMSException
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.
javax.jms.JMSException
- if an internal error occurs. getTempTopicPrefix
- public java.lang.String getTempTopicPrefix( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getTempQPrefix
- public java.lang.String getTempQPrefix( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getTransportType
- public int getTransportType()
getUseConnectionPooling
- @Deprecated
- public boolean getUseConnectionPooling( )
setUseConnectionPooling(boolean usePooling)
this property has no effect in the current release
getVersion
- public int getVersion()
getWildcardFormat
- public int getWildcardFormat()
- throws javax.jms.JMSException
javax.jms.JMSException
- if an internal error occurs. getAppName
- public java.lang.String getAppName( )
getAsyncExceptions
- public int getAsyncExceptions()
setBrokerCCSubQueue
- public void setBrokerCCSubQueue( java.lang.String queueName)
- throws javax.jms.JMSException
queueName
- the name of queue. javax.jms.JMSException
- if queueName is either null or invalid. setBrokerControlQueue
- public void setBrokerControlQueue( java.lang.String queueName)
- throws javax.jms.JMSException
queueName
- the name of the broker control queue. javax.jms.JMSException
- if the name is either null or invalid. setBrokerPubQueue
- public void setBrokerPubQueue(java.lang.String queueName)
- throws javax.jms.JMSException
queueName
- the name of the publish queue. javax.jms.JMSException
- if queueName is either null or invalid. setBrokerQueueManager
- public void setBrokerQueueManager( java.lang.String queueManagerName)
- throws javax.jms.JMSException
queueManagerName
- the name of the queue manager. javax.jms.JMSException
- if queueManagerName is either null or invalid. setBrokerSubQueue
- public void setBrokerSubQueue(java.lang.String queueName)
- throws javax.jms.JMSException
queueName
- the name of the queue. javax.jms.JMSException
- if queueName is either null or invalid. setBrokerVersion
- public void setBrokerVersion(int version)
- throws javax.jms.JMSException
version
- possible values are:
javax.jms.JMSException
- if version is invalid. setCCDTURL
- public void setCCDTURL(java.net.URL url)
url
- the address of the client channel definition table. setCCSID
- public void setCCSID(int ccsid)
- throws javax.jms.JMSException
ccsid
- the CCSID. The default value (819) is suitable in most situations. javax.jms.JMSException
- if the value of ccsid is not permitted. setChannel
- public void setChannel(java.lang.String channelName)
- throws javax.jms.JMSException
channelName
- the name of the channel. javax.jms.JMSException
- if channelName is either null or too long. setCleanupInterval
- public void setCleanupInterval( long interval)
- throws javax.jms.JMSException
interval
- the clean up interval (milliseconds). javax.jms.JMSException
- if interval is either null or too long. setCleanupLevel
- public void setCleanupLevel(int level)
- throws javax.jms.JMSException
level
- permitted levels are:
javax.jms.JMSException
- if level is not as listed above. setClientID
- public void setClientID(java.lang.String id)
Note that this method always throws an IllegalStateException when you make a real-time connection to a broker.
id
- the client ID. setClientId
- @Deprecated
- public void setClientId( java.lang.String id)
Note that this method always throws an IllegalStateException when you make a real-time connection to a broker.
id
- the client ID. setConnTag
- public void setConnTag(byte[] cTag)
cTag
- the connection tag. The value is truncated if it is longer than 128 bytes. setDescription
- public void setDescription(java.lang.String desc)
desc
- the description. setDirectAuth
- public void setDirectAuth(int authority)
- throws javax.jms.JMSException
authority
- one of the following:
javax.jms.JMSException
- if authority is neither of the above. setFailIfQuiesce
- public void setFailIfQuiesce(int fiq)
- throws javax.jms.JMSException
fiq
- acceptable values are:
javax.jms.JMSException
- if fiq is neither of the above. setHdrCompList
- public void setHdrCompList(java.util.Collection<?> compList)
- throws javax.jms.JMSException
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. javax.jms.JMSException
setHostName
- public void setHostName(java.lang.String hostname)
hostname
- the name of the host. setLocalAddress
- public void setLocalAddress(java.lang.String address)
- throws javax.jms.JMSException
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.
javax.jms.JMSException
- if the format of the local address is incorrect. setMapNameStyle
- public void setMapNameStyle(boolean style)
style
- possible values are:
setMaxBufferSize
- public void setMaxBufferSize(int size)
- throws javax.jms.JMSException
size
- the maximum buffer size. javax.jms.JMSException
- if size is negative. setMessageRetention
- public void setMessageRetention( int mRet)
- throws javax.jms.JMSException
mRet
- possible values are:
javax.jms.JMSException
- if mRet is not one of the above. setMessageSelection
- public void setMessageSelection( int selection)
- throws javax.jms.JMSException
selection
- possible values are:
javax.jms.JMSException
- if selection is not one of the above. setMQConnectionOptions
- public void setMQConnectionOptions( int cTagOpt)
- throws javax.jms.JMSException
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. javax.jms.JMSException
- if an option or a combination of set options is invalid. setMsgBatchSize
- public void setMsgBatchSize(int size)
- throws javax.jms.JMSException
size
- the maximum number of messages to be taken at once when using asynchronous
delivery. javax.jms.JMSException
setMsgCompList
- public void setMsgCompList(java.util.Collection<?> compList)
- throws javax.jms.JMSException
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. javax.jms.JMSException
setMulticast
- public void setMulticast(int multicast)
- throws javax.jms.JMSException
multicast
- the following values are possible:
javax.jms.JMSException
- if multicast does not belong to the above. setOptimisticPublication
- @Deprecated
- public void setOptimisticPublication( boolean newVal)
- throws javax.jms.JMSException
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. javax.jms.JMSException
setOutcomeNotification
- @Deprecated
- public void setOutcomeNotification( boolean newVal)
- throws javax.jms.JMSException
newVal
- true if MessageConsumers are to be informed, false if not. javax.jms.JMSException
setPollingInterval
- public void setPollingInterval( int interval)
- throws javax.jms.JMSException
interval
- the interval in milliseconds. javax.jms.JMSException
setPort
- public void setPort(int port)
- throws javax.jms.JMSException
port
- the new value to use. javax.jms.JMSException
- if port is not a permitted value. setProcessDuration
- @Deprecated
- public void setProcessDuration( int newVal)
- throws javax.jms.JMSException
newVal
- the process duration (milliseconds). javax.jms.JMSException
setProviderVersion
- public void setProviderVersion( java.lang.String version)
- throws javax.jms.JMSException
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". javax.jms.JMSException
- if the version is invalid setProxyHostName
- public void setProxyHostName(java.lang.String hostName)
- throws javax.jms.JMSException
hostName
- the host name of the proxy server when establishing a real-time connection, or
null if no proxy server is used. javax.jms.JMSException
- if an internal error occurs. setProxyPort
- public void setProxyPort(int proxyPort)
- throws javax.jms.JMSException
proxyPort
- the port number of the proxy server when establishing a real-time connection. javax.jms.JMSException
- if an internal error occurs. setPubAckInterval
- public void setPubAckInterval(int interval)
- throws javax.jms.JMSException
interval
- the number of messages to use as an interval. The default is 25. javax.jms.JMSException
- if an internal error occurs. setQueueManager
- public void setQueueManager(java.lang.String queueManagerName)
- throws javax.jms.JMSException
queueManagerName
- the queue manager which is used when selecting a channel definition.
This can be in of the following forms: javax.jms.JMSException
- if queueManagerName is either null or too long. setReceiveExit
- public void setReceiveExit(java.lang.String receiveExit)
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)
data
- the initialization string. setReceiveIsolation
- @Deprecated
- public void setReceiveIsolation( int newVal)
- throws javax.jms.JMSException
newVal
- one of these values:
-
WMQConstants.WMQ_RCVISOL_COMMITTED
-
WMQConstants.WMQ_RCVISOL_UNCOMMITTED
javax.jms.JMSException
setRescanInterval
- public void setRescanInterval(int interval)
- throws javax.jms.JMSException
interval
- the interval in milliseconds. javax.jms.JMSException
setSecurityExit
- public void setSecurityExit(java.lang.String securityExit)
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)
data
- the initialization string. setSendCheckCount
- public void setSendCheckCount(int interval)
- throws javax.jms.JMSException
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. javax.jms.JMSException
- if an internal error occurs. setSendExit
- public void setSendExit(java.lang.String sendExit)
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)
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
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. javax.jms.JMSException
- if an internal error occurs. setSparseSubscriptions
- public void setSparseSubscriptions( boolean sparse)
- throws javax.jms.JMSException
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 . javax.jms.JMSException
- if an internal error occurs. setSSLCertStores
- public void setSSLCertStores(java.util.Collection<?> stores)
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.
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
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. javax.jms.JMSException
- if the ConnectionFactory supplied list of LDAP URIs is not valid. setSSLCipherSuite
- public void setSSLCipherSuite(java.lang.String cipherSuite)
cipherSuite
- the CipherSuite used for SSL encryption. If set to null (the default), no
SSL encryption is performed. setSSLFipsRequired
- public void setSSLFipsRequired( boolean required)
required
- true indicates FIPS is required. setSSLPeerName
- public void setSSLPeerName(java.lang.String peerName)
- throws javax.jms.JMSException
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. javax.jms.JMSException
- if the supplied pattern is not valid. setSSLResetCount
- public void setSSLResetCount(int bytes)
- throws javax.jms.JMSException
bytes
- the reset count. This must be an integer, with a value between 0 (disabled) and
999 999 999. javax.jms.JMSException
- if bytes is not within the valid range. setSSLSocketFactory
- public void setSSLSocketFactory( java.lang.Object sf)
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
interval
- the time between transactions to refresh publish/subscribe status
(milliseconds). javax.jms.JMSException
- if an internal error occurs. setSubscriptionStore
- public void setSubscriptionStore( int flag)
- throws javax.jms.JMSException
flag
- an integer which represents a valid values of the SUBSTORE property:
javax.jms.JMSException
- if flag is not one of the above. setSyncpointAllGets
- public void setSyncpointAllGets( boolean flag)
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)
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.
matchClient
- a boolean indicating whether to enable or disable target client matching. setTemporaryModel
- public void setTemporaryModel(java.lang.String queueName)
- throws javax.jms.JMSException
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.
javax.jms.JMSException
- if queueName is either null or too long. setTempTopicPrefix
- public void setTempTopicPrefix( java.lang.String prefix)
- throws javax.jms.JMSException
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>. javax.jms.JMSException
- if an internal error occurs. setTempQPrefix
- public void setTempQPrefix(java.lang.String newTempQPrefix)
- throws javax.jms.JMSException
newTempQPrefix
- the prefix to be used to form the name of a WebSphere MQ dynamic queue.
This must end with the '*' character. 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
type
- the transport type. Valid types are:
javax.jms.JMSException
- if the transport is not one of the above. setUseConnectionPooling
- @Deprecated
- public void setUseConnectionPooling( boolean usePooling)
usePooling
- true sets the useConnectionPooling property. setWildcardFormat
- public void setWildcardFormat(int format)
- throws javax.jms.JMSException
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. javax.jms.JMSException
- if an internal error occurs. setAppName
- public void setAppName(java.lang.String name)
- throws javax.jms.JMSException
name
- javax.jms.JMSException
setAsyncExceptions
- public void setAsyncExceptions( int flags)
- throws javax.jms.JMSException
flags
- the ASYNC_EXCEPTIONS_* filter options javax.jms.JMSException
createConnection
- public javax.jms.Connection createConnection( )
- throws javax.jms.JMSException
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.
createConnection
in interface javax.jms.ConnectionFactory
createConnection
in class com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
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
createConnection
in interface javax.jms.ConnectionFactory
createConnection
in class com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl
userID
- the caller's user identity. password
- the caller's password. 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
javax.jms.JMSException
- If the reconnection options cannot be retrieved setClientReconnectOptions
- public void setClientReconnectOptions( int options)
- throws javax.jms.JMSException
- 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
options
- New reconnection options javax.jms.JMSException
- If the reconnection options cannot be set getConnectionNameList
- public java.lang.String getConnectionNameList( )
- throws javax.jms.JMSException
javax.jms.JMSException
- If the connection name list cannot be retrieved setConnectionNameList
- public void setConnectionNameList( java.lang.String hosts)
- throws javax.jms.JMSException
eg. 127.0.0.1(1414),host2.example.com(1400) The default setting of this property is 'localhost(1414)'
hosts
- The hosts to connect to javax.jms.JMSException
- If the connection name list cannot be set getClientReconnectTimeout
- public int getClientReconnectTimeout( )
- throws javax.jms.JMSException
javax.jms.JMSException
- if the reconnection timeout cannot be retrieved setClientReconnectTimeout
- public void setClientReconnectTimeout( int timeout)
- throws javax.jms.JMSException
timeout
- is the time in seconds to reconnect javax.jms.JMSException
- if the reconnection timeout cannot be set