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 you use the IBM MQ JMS administration tool, see Configuring 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 Configuring 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.

Table 1. Property names and applicable object types
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
[MQ 9.3.4 Oct 2023]BALOPTIONS OPTIONS Y Y Y     Y Y Y
[MQ 9.3.4 Oct 2023]BALTYPE TYPE Y Y Y     Y Y Y
[MQ 9.3.4 Oct 2023]BALTIMEOUT TIMEOUT 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:
  1. This property can be used with version 70 of IBM MQ classes for JMS but has no effect for an application connected to a IBM WebSphere® MQ 7.0 queue manager unless the PROVIDERVERSION property of the connection factory is set to a version number less than 7.
  2. Only the BROKERVER, CLIENTID, DESCRIPTION, DIRECTAUTH, HOSTNAME, LOCALADDRESS, MAXBUFFSIZE, MULTICAST, PORT, PROXYHOSTNAME, PROXYPORT, and TRANSPORT properties are supported for a ConnectionFactory or TopicConnectionFactory object when using a real-time connection to a broker.
  3. The CCDTURL and CHANNEL properties of an object must not both be set at the same time.