Properties of IBM MQ classes for JMS objects
All objects in IBM MQ classes for JMS have properties. Different properties apply to different object types. Different properties have different allowable values, and symbolic property values differ between the administration tool and program code.
IBM MQ classes for JMS provides facilities to set and query the properties of objects using the IBM MQ JMS administration tool, IBM MQ Explorer, or in an application. Many of the properties are relevant only to a specific subset of the object types.
For information on how we use the IBM MQ JMS administration tool, see Configure JMS objects using the administration tool.
Table 1 gives a brief description of each property and shows for each property which object types it applies to. The object types are identified using keywords; see Configure JMS objects using the administration tool for an explanation of these objects.Numbers refer to notes at the end of the table. See also Dependencies between properties of IBM MQ classes for JMS objects.
A property consists of a name-value pair in the format:PROPERTY_NAME(property_value)
The topics in this section list, for each property, the name of the property and a brief description, and shows the valid property values used in the administration tool. and the set method that is used to set the value of the property in an application. The topics also show the valid property values for each property and the mapping between symbolic property values used in the tool and their programmable equivalents.
Property names are not case-sensitive, and are restricted to the set of recognized names shown in these topics.
| Property | Short form | Object type | |||||||
|---|---|---|---|---|---|---|---|---|---|
| CF | QCF | TCF | Q | T | XACF | XAQCF | XATCF | ||
| APPLICATIONNAME | APPNAME | Y | Y | Y | Y | Y | Y | ||
| ASYNCEXCEPTION | AEX | Y | Y | Y | Y | Y | Y | ||
| BROKERCCDURSUBQ 1 | CCDSUB | Y | |||||||
| BROKERCCSUBQ 1 | CCSUB | Y | Y | Y | Y | ||||
| BROKERCONQ 1 | BCON | Y | Y | Y | Y | ||||
| BROKERDURSUBQ 1 | BDSUB | Y | |||||||
| BROKERPUBQ 1 | BPUB | Y | Y | Y | Y | Y | |||
| BROKERPUBQMGR 1 | BPQM | Y | |||||||
| BROKERQMGR 1 | BQM | Y | Y | Y | Y | ||||
| BROKERSUBQ 1 | BSUB | Y | Y | Y | Y | ||||
| BROKERVER 1 | BVER | Y 2 | Y 2 | Y | Y | Y | |||
| CCDTURL 3 | CCDT | Y | Y | Y | Y | Y | Y | ||
| CCSID | CCS | Y | Y | Y | Y | Y | Y | Y | Y |
| CHANNEL 3 | CHAN | Y | Y | Y | Y | Y | Y | ||
| CLEANUP 1 | CL | Y | Y | Y | Y | ||||
| CLEANUPINT 1 | CLINT | Y | Y | Y | Y | ||||
| CONNECTIONNAMELIST | CNLIST | Y | Y | Y | |||||
| CLIENTRECONNECTOPTIONS | CROPT | Y | Y | Y | |||||
| CLIENTRECONNECTTIMEOUT | CRT | Y | Y | Y | |||||
| CLIENTID | CID | Y 2 | Y | Y 2 | Y | Y | Y | ||
| CLONESUPP | CLS | Y | Y | Y | Y | ||||
| COMPHDR | HC | Y | Y | Y | Y | ||||
| COMPMSG | MC | Y | Y | Y | Y | Y | Y | ||
| CONNOPT | CNOPT | Y | Y | Y | Y | Y | Y | ||
| CONNTAG | CNTAG | Y | Y | Y | Y | Y | Y | ||
| DESCRIPTION | DESC | Y 2 | Y | Y 2 | Y | Y | Y | Y | Y |
| DIRECTAUTH | DAUTH | Y 2 | Y 2 | ||||||
| ENCODING | ENC | Y | Y | ||||||
| EXPIRY | EXP | Y | Y | ||||||
| FAILIFQUIESCE | FIQ | Y | Y | Y | Y | Y | Y | Y | Y |
| HOSTNAME | HOST | Y 2 | Y | Y 2 | Y | Y | Y | ||
| LOCALADDRESS | LA | Y 2 | Y | Y 2 | Y | Y | Y | ||
| MAPNAMESTYLE | MNST | Y | Y | Y | Y | Y | Y | ||
| MAXBUFFSIZE | MBSZ | Y 2 | Y 2 | ||||||
| MDREAD | MDR | Y | Y | ||||||
| MDWRITE | MDW | Y | Y | ||||||
| MDMSGCTX | MDCTX | Y | Y | ||||||
| MSGBATCHSZ 1 | MBS | Y | Y | Y | Y | Y | Y | ||
| MSGBODY | MBODY | Y | Y | ||||||
| MSGRETENTION | MRET | Y | Y | Y | Y | ||||
| MSGSELECTION 1 | MSEL | Y | Y | Y | Y | ||||
| MULTICAST | MCAST | Y 2 | Y 2 | Y | |||||
| OPTIMISTICPUBLICATION 1 | OPTPUB | Y | Y | ||||||
| OUTCOMENOTIFICATION 1 | NOTIFY | Y | Y | ||||||
| PERSISTENCE | PER | Y | Y | ||||||
| POLLINGINT 1 | PINT | Y | Y | Y | Y | Y | Y | ||
| PORT | PORT | Y 2 | Y | Y 2 | Y | Y | Y | ||
| PRIORITY | PRI | Y | Y | ||||||
| PROCESSDURATION 1 | PROCDUR | Y | Y | ||||||
| PROVIDERVERSION | PVER | Y | Y | Y | Y | Y | Y | ||
| PROXYHOSTNAME | PHOST | Y 2 | Y 2 | ||||||
| PROXYPORT | PPORT | Y 2 | Y 2 | ||||||
| PUBACKINT 1 | PAI | Y | Y | Y | Y | ||||
| PUTASYNCALLOWED | PAALD | Y | Y | ||||||
| QMANAGER | QMGR | Y | Y | Y | Y | Y | Y | Y | |
| QUEUE | QU | Y | |||||||
| READAHEADALLOWED | RAALD | Y | Y | ||||||
| READAHEADCLOSEPOLICY | RACP | Y | Y | ||||||
| RECEIVECCSID | RCCS | Y | Y | ||||||
| RECEIVECONVERSION | RCNV | Y | Y | ||||||
| RECEIVEISOLATION 1 | RCVISOL | Y | Y | ||||||
| RECEXIT | RCX | Y | Y | Y | Y | Y | Y | ||
| RECEXITINIT | RCXI | Y | Y | Y | Y | Y | Y | ||
| REPLYTOSTYLE | RTOST | Y | Y | ||||||
| RESCANINT 1 | RINT | Y | Y | Y | Y | ||||
| SECEXIT | SCX | Y | Y | Y | Y | Y | Y | ||
| SECEXITINIT | SCXI | Y | Y | Y | Y | Y | Y | ||
| SENDCHECKCOUNT | SCC | Y | Y | Y | Y | Y | Y | ||
| SENDEXIT | SDX | Y | Y | Y | Y | Y | Y | ||
| SENDEXITINIT | SDXI | Y | Y | Y | Y | Y | Y | ||
| SHARECONVALLOWED | SCALD | Y | Y | Y | Y | Y | Y | ||
| SPARSESUBS 1 | SSUBS | Y | Y | ||||||
| SSLCIPHERSUITE | SCPHS | Y | Y | Y | Y | Y | Y | ||
| SSLCRL | SCRL | Y | Y | Y | Y | Y | Y | ||
| SSLFIPSREQUIRED | SFIPS | Y | Y | Y | Y | Y | Y | ||
| SSLPEERNAME | SPEER | Y | Y | Y | Y | Y | Y | ||
| SSLRESETCOUNT | SRC | Y | Y | Y | Y | Y | Y | ||
| STATREFRESHINT 1 | SRI | Y | Y | Y | Y | ||||
| SUBSTORE 1 | SS | Y | Y | Y | Y | ||||
| SYNCPOINTALLGETS | SPAG | Y | Y | Y | Y | Y | Y | ||
| TARGCLIENT | TC | Y | Y | ||||||
| TARGCLIENTMATCHING | TCM | Y | Y | Y | Y | ||||
| TEMPMODEL | TM | Y | Y | Y | Y | ||||
| TEMPQPREFIX | TQP | Y | Y | Y | Y | ||||
| TEMPTOPICPREFIX | TTP | Y | Y | Y | Y | ||||
| TOPIC | TOP | Y | |||||||
| TRANSPORT | TRAN | Y 2 | Y | Y 2 | Y | Y | Y | ||
| WILDCARDFORMAT | WCFMT | Y | Y | Y | Y | ||||
Note:
|
|||||||||
- Dependencies between properties of IBM MQ classes for JMS objects
The validity of some properties is dependent on the particular values of other properties. - APPLICATIONNAME
An application can set a name that identifies its connection to the queue manager. This application name is shown by the DISPLAY CONN MQSC/PCF command (where the field is called APPLTAG ) or in the IBM MQ Explorer Application Connections display (where the field is called App name ). - ASYNCEXCEPTION
This property determines whether IBM MQ classes for JMS informs an ExceptionListener only when a connection is broken, or when any exception occurs asynchronously to a JMS API call. This applies to all Connections created from this ConnectionFactory that have an ExceptionListener registered. - BROKERCCDURSUBQ
The name of the queue from which durable subscription messages are retrieved for a ConnectionConsumer. - BROKERCCSUBQ
The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer. - BROKERCONQ
The control queue name of the broker. - BROKERDURSUBQ
When the IBM MQ classes for JMS are being used in IBM MQ messaging provider migration mode, this property specifies the name of the queue from which durable subscription messages are retrieved. - BROKERPUBQ
The name of the queue where published messages are sent (the stream queue). - BROKERPUBQMGR
The name of the queue manager that owns the queue where messages published on the topic are sent. - BROKERQMGR
The name of the queue manager on which the broker is running. - BROKERSUBQ
When the IBM MQ classes for JMS are being used in IBM MQ messaging provider migration mode, this property specifies the name of the queue from which non-durable subscription messages are retrieved. - BROKERVER
The version of the broker being used. - CCDTURL
A Uniform Resource Locator (URL) that identifies the name and location of the file containing the client channel definition table and specifies how the file can be accessed. - CCSID
The coded character set ID to be used for a connection or destination. - CHANNEL
The name of the client connection channel being used. - CLEANUP
Cleanup Level for BROKER or MIGRATE Subscription Stores. - CLEANUPINT
The interval, in milliseconds, between background executions of the publish/subscribe cleanup utility. - CONNECTIONNAMELIST
List of TCP/IP connection names. The list is tried in order, once per each reconnection retry attempt. - CLIENTRECONNECTOPTIONS
Options governing reconnection. - CLIENTRECONNECTTIMEOUT
Time before reconnection retries cease. - CLIENTID
The client identifier is used to uniquely identify the application connection for durable subscriptions. - CLONESUPP
Whether two or more instances of the same durable topic subscriber can run simultaneously. - COMPHDR
A list of the techniques that can be used for compressing header data on a connection. - COMPMSG
A list of the techniques that can be used for compressing message data on a connection. - CONNOPT
Controls how IBM MQ classes for JMS applications that use the bindings transport connect to the queue manager. - CONNTAG
A tag that the queue manager associates with the resources updated by the application within a unit of work while the application is connected to the queue manager. - DESCRIPTION
A description of the stored object. - DIRECTAUTH
Whether TLS authentication is used on a real-time connection to a broker. - ENCODING
How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. - EXPIRY
The time after which messages at a destination expire. - FAILIFQUIESCE
This property determines whether calls to certain methods fail if either the queue manager is in a quiescing state, or an application is connecting to a queue manager using the CLIENT transport and the channel that the application is using has been put into a quiescing state, for example, by using the STOP CHANNEL or STOP CHANNEL MODE(QUIESCE) MQSC command. - HOSTNAME
For a connection to a queue manager, the host name or IP address of the system on which the queue manager is running or, for a real-time connection to a broker, the host name or IP address of the system on which the broker is running. - LOCALADDRESS
For a connection to a queue manager, this property specifies either the local network interface to be used, or the local port, or range of local ports, to be used. - MAPNAMESTYLE
Allows compatibility style to be used for MapMessage element names. - MAXBUFFSIZE
The maximum number of received messages that can be stored in an internal message buffer while waiting to be processed by the application. This property applies only when TRANSPORT has the value DIRECT or DIRECTHTTP. - MDREAD
This property determines whether a JMS application can extract the values of MQMD fields. - MDWRITE
This property determines whether a JMS application can set the values of MQMD fields. - MDMSGCTX
What level of message context is to be set by the JMS application. The application must be running with appropriate context authority for this property to take effect. - MSGBATCHSZ
The maximum number of messages to be taken from a queue in one packet when using asynchronous message delivery. - MSGBODY
Determines whether a JMS application accesses the MQRFH2 of an IBM MQ message as part of the message payload. - MSGRETENTION
Whether the connection consumer keeps undelivered messages on the input queue. - MSGSELECTION
Determines whether message selection is done by the IBM MQ classes for JMS or by the broker. If TRANSPORT has the value DIRECT, message selection is always done by the broker and the value of MSGSELECTION is ignored. Message selection by the broker is not supported when BROKERVER has the value V1. - MULTICAST
To enable multicast on a real-time connection to a broker and, if enabled, to specify the precise way in which multicast is used to deliver messages from the broker to a message consumer. The property has no effect on how a message producer sends messages to a broker. - OPTIMISTICPUBLICATION
This property determines whether IBM MQ classes for JMS returns control immediately to a publisher that has published a message, or whether it returns control only after it has completed all the processing associated with the call and can report the outcome to the publisher. - OUTCOMENOTIFICATION
This property determines whether IBM MQ classes for JMS return control immediately to a subscriber that has just acknowledged or committed a message, or whether it returns control only after it has completed all the processing associated with the call and can report the outcome to the subscriber. - PERSISTENCE
The persistence of messages sent to a destination. - POLLINGINT
If each message listener within a session has no suitable message on its queue, this is the maximum interval, in milliseconds, that elapses before each message listener tries again to get a message from its queue. If it frequently happens that no suitable message is available for any of the message listeners in a session, consider increasing the value of this property. This property is relevant only if TRANSPORT has the value BIND or CLIENT. - PORT
For a connection to a queue manager, the number of the port on which the queue manager is listening or, for a real-time connection to a broker, the number of the port on which the broker is listening for real-time connections. - PRIORITY
The priority for messages sent to a destination. - PROCESSDURATION
This property determines whether a subscriber guarantees to process quickly any message it receives before returning control to IBM MQ classes for JMS. - PROVIDERVERSION
This property differentiates between the three IBM MQ messaging modes of operation: IBM MQ messaging provider normal mode, IBM MQ messaging provider normal mode with restrictions, and IBM MQ messaging provider migration mode. - PROXYHOSTNAME
The host name or IP address of the system on which the proxy server is running when using a real-time connection to a broker through a proxy server. - PROXYPORT
The number of the port on which the proxy server is listening when using a real-time connection to a broker through a proxy server. - PUBACKINT
The number of messages published by a publisher before IBM MQ classes for JMS requests an acknowledgment from the broker. - PUTASYNCALLOWED
This property determines whether message producers are allowed to use asynchronous puts to send messages to this destination. - QMANAGER
The name of the queue manager to connect to. - QUEUE
The name of the JMS queue destination. This matches the name of the queue used by the queue manager. - READAHEADALLOWED
This property determines whether message consumers and queue browsers are allowed to use read ahead to get nonpersistent messages from this destination into an internal buffer before receiving them. - READAHEADCLOSEPOLICY
For messages being delivered to an asynchronous message listener, what happens to messages in the internal read ahead buffer when the message consumer is closed. - RECEIVECCSID
Destination property that sets the target CCSID for queue manager message conversion. The value is ignored unless RECEIVECONVERSION is set to WMQ_RECEIVE_CONVERSION_QMGR - RECEIVECONVERSION
Destination property that determines if data conversion is going to be performed by the queue manager. - RECEIVEISOLATION
This property determines whether a subscriber might receive messages that have not been committed on the subscriber queue. - RECEXIT
Identifies a channel receive exit, or a sequence of receive exits, to be run in succession. - RECEXITINIT
The user data that is passed to channel receive exits when they are called. - REPLYTOSTYLE
Determines how the JMSReplyTo field in a received message is constructed. - RESCANINT
When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, IBM MQ classes for JMS search the IBM MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. - SECEXIT
Identifies a channel security exit. - SECEXITINIT
The user data that is passed to a channel security exit when it is called. - SENDCHECKCOUNT
The number of send calls to allow between checking for asynchronous put errors, within a single non-transacted JMS session. - SENDEXIT
Identifies a channel send exit, or a sequence of send exits to be run in succession. - SENDEXITINIT
The user data that is passed to channel send exits when they are called. - SHARECONVALLOWED
This property determines whether a client connection can share its socket with other top-level JMS connections from the same process to the same queue manager, if the channel definitions match. - SPARSESUBS
Controls the message retrieval policy of a TopicSubscriber object. - SSLCIPHERSUITE
The CipherSuite to use for a TLS connection. - SSLCRL
CRL servers to check for TLS certificate revocation. - SSLFIPSREQUIRED
This property determines whether a TLS connection must use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS). - SSLPEERNAME
For TLS, a distinguished name skeleton that must match that provided by the queue manager. - SSLRESETCOUNT
For TLS, the total number of bytes sent and received by a connection before the secret key that is used for encryption is renegotiated. - STATREFRESHINT
The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. - SUBSTORE
Where IBM MQ classes for JMS stores persistent data relating to active subscriptions. - SYNCPOINTALLGETS
This property determines whether all gets are to be performed under syncpoint. - TARGCLIENT
This property determines whether the IBM MQ RFH2 format is used to exchange information with target applications. - TARGCLIENTMATCHING
This property determines whether a reply message, sent to the queue identified by the JMSReplyTo header field of an incoming message, has an MQRFH2 header only if the incoming message has an MQRFH2 header. - TEMPMODEL
The name of the model queue from which JMS temporary queues are created. - TEMPQPREFIX
The prefix that is used to form the name of an IBM MQ dynamic queue. - TEMPTOPICPREFIX
When creating temporary topics, JMS generates a topic string of the form ''TEMP /TEMPTOPICPREFIX/unique_id '', or if this property is left with the default value, just ''TEMP /unique_id ''. Specifying a non-empty TEMPTOPICPREFIX allows specific model queues to be defined for creating the managed queues for subscribers to temporary topics created under this connection. - TOPIC
The name of the JMS topic destination, this value is used by the queue manager as the topic string of a publication or subscription. - TRANSPORT
The nature of a connection to a queue manager or broker. - WILDCARDFORMAT
This property determines which version of wildcard syntax is to be used. - The ENCODING property
The ENCODING property comprises three sub-properties, in twelve possible combinations. - TLS properties of JMS objects
Enable Transport Layer Security (TLS) encryption using the SSLCIPHERSUITE property. We can then change the characteristics of the TLS encryption using several other properties.
Parent topic: Developing applications reference