Properties

 

A property consists of a name-value pair in the format:

PROPERTY_NAME(property_value)

Property names are not case-sensitive, and are restricted to the set of recognized names shown in Table 1. This table also shows the valid property values for each property.

Property names and valid values
Property Short form Valid values (defaults in bold)
BROKERCCDURSUBQ CCDSUB

BROKERCCSUBQ CCSUB

BROKERCONQ BCON

BROKERDURSUBQ BDSUB

BROKERPUBQ BPUB

BROKERPUBQMGR BPQM Any string
BROKERQMGR BQM Any string
BROKERSUBQ BSUB

BROKERVER BVER

  • V1 - To use a WebSphere MQ Publish/Subscribe broker, or to use a broker of WebSphere MQ Integrator, WebSphere MQ Event Broker, WebSphere Business Integration Event Broker, or WebSphere Business Integration Message Broker in compatibility mode. This is the default value if TRANSPORT is set to BIND or CLIENT.

  • V2 - To use a broker of WebSphere MQ Integrator, WebSphere MQ Event Broker, WebSphere Business Integration Event Broker, or WebSphere Business Integration Message Broker in native mode. This is the default value if TRANSPORT is set to DIRECT or DIRECTHTTP.

CCDTURL1 CCDT

  • Not set

  • A uniform resource locator (URL)

CCSID CCS

  • 819 - This is the default for a connection factory.

  • 1208 - This is the default for a destination.

  • Any positive integer

CHANNEL1 CHAN

  • SYSTEM.DEF.SVRCONN

  • Any string

CLEANUP CL

  • SAFE

  • ASPROP

  • NONE

  • STRONG

CLEANUPINT CLINT

  • 3 600 000

  • Any positive integer

CLIENTID CID Any string
CLONESUPP CLS

  • DISABLED - Only one instance of a durable topic subscriber can run at a time.

  • ENABLED2 - Two or more instances of the same durable topic subscriber can run simultaneously, but each instance must run in a separate Java™ virtual machine (JVM).

COMPHDR HC

  • NONE

  • SYSTEM

COMPMSG MC

  • NONE

  • A list of one or more of the following values separated by blank characters:
    • RLE

    • ZLIBFAST

    • ZLIBHIGH

CONNOPT3 CNOPT

  • STANDARD - The nature of the binding between the application and the queue manager depends on the platform on which the queue manager is running and how the queue manager is configured.

  • SHARED - The application and the local queue manager agent run in separate units of execution but share some resources.

  • ISOLATED - The application and the local queue manager agent run in separate units of execution and share no resources.

  • FASTPATH - The application and the local queue manager agent run in the same unit of execution.

  • SERIALQM - The application requests exclusive use of the connection tag within the scope of the queue manager.

  • SERIALQSG - The application requests exclusive use of the connection tag within the scope of the queue sharing group to which the queue manager belongs.

  • RESTRICTQM - The application requests shared use of the connection tag, but there are restrictions on the shared use of the connection tag within the scope of the queue manager.

  • RESTRICTQSG - The application requests shared use of the connection tag, but there are restrictions on the shared use of the connection tag within the scope of the queue sharing group to which the queue manager belongs.

CONNTAG CNTAG Any string. The value is truncated if it is longer than 128 bytes.
DESCRIPTION DESC Any string
DIRECTAUTH DAUTH

  • BASIC - No authentication, username authentication, or password authentication

  • CERTIFICATE - Public key certificate authentication

ENCODING ENC See The ENCODING property
EXPIRY EXP

  • APP - Expiry may be defined by the JMS application.

  • UNLIM - No expiry occurs.

  • Any positive integer representing expiry in milliseconds.

FAILIFQUIESCE FIQ

  • YES - Calls to certain methods fail if the queue manager is in a quiescing state. If an application detects that the queue manager is quiescing, the application can complete its immediate task and close the connection, allowing the queue manager to stop.

  • NO - No method call fails because the queue manager is in a quiescing state. If you specify this value, an application cannot detect that the queue manager is quiescing. The application might continue to perform operations against the queue manager, and therefore prevent the queue manager from stopping.

HOSTNAME HOST

  • localhost

  • Any string

LOCALADDRESS LA

  • Not set

  • A string in the format [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
    We can specify a host name instead of an IP address.

    For a direct connection to a broker, this property is relevant only when multicast is used, and the value of the property must not contain a port number, or a range of port numbers. The only valid values of the property in this case are null, an IP address, or a host name.

MAPNAMESTYLE MNST

  • STANDARD - Map messages are sent in the current format, which can be interpreted only by the current version or V5.3 of WebSphere MQ JMS.

  • COMPATIBLE - Map messages are sent in an earlier format, which can be interpreted by any version of WebSphere MQ JMS, including versions earlier than V5.3.

MAXBUFFSIZE MBSZ

  • 1000

  • Any positive integer

MSGBATCHSZ MBS

  • 10

  • Any positive integer

MSGRETENTION MRET

  • Yes - Unwanted messages remain on the input queue

  • No - Unwanted messages are dealt with according to their disposition options

MSGSELECTION MSEL

  • CLIENT - Message selection is done by the client.

  • BROKER - Message selection is done by the broker.

MULTICAST MCAST

  • DISABLED - Messages are not delivered to a message consumer using multicast transport. This is the default value for ConnectionFactory and TopicConnectionFactory objects.

  • ASCF - Messages are delivered to a message consumer according to the multicast setting for the connection factory associated with the message consumer. The multicast setting for the connection factory is noted at the time that the message consumer is created. This value is valid only for Topic objects, and is the default value for Topic objects.

  • ENABLED - If the topic is configured for multicast in the broker, messages are delivered to a message consumer using multicast transport. A reliable quality of service is used if the topic is configured for reliable multicast.

  • RELIABLE - If the topic is configured for reliable multicast in the broker, messages are delivered to the message consumer using multicast transport with a reliable quality of service. If the topic is not configured for reliable multicast, we cannot create a message consumer for the topic.

  • NOTR - If the topic is configured for multicast in the broker, messages are delivered to the message consumer using multicast transport. A reliable quality of service is not used even if the topic is configured for reliable multicast.

OPTIMISTICPUBLICATION OPTPUB

  • NO - When a publisher publishes a message, the WebSphere MQ JMS client does not return control to the publisher until it has completed all the processing associated with the call and can report the outcome to the publisher.

  • YES - When a publisher publishes a message, the WebSphere MQ JMS client returns control to the publisher immediately, before it has completed all the processing associated with the call and can report the outcome to the publisher. The WebSphere MQ JMS client reports the outcome only when the publisher commits the message.

OUTCOMENOTIFICATION NOTIFY

  • YES - When a subscriber acknowledges or commits a message, the WebSphere MQ JMS client does not return control to the subscriber until it has completed all the processing associated with the call and can report the outcome to the subscriber.

  • NO4 - When a subscriber acknowledges or commits a message, the WebSphere MQ JMS client returns control to the subscriber immediately, before it has completed all the processing associated with the call and can report the outcome to the subscriber.

PERSISTENCE PER

  • APP - Persistence is defined by the JMS application.

  • QDEF - Persistence takes the value of the queue default.

  • PERS - Messages are persistent.

  • NON - Messages are nonpersistent.

  • HIGH - See JMS persistent messages.

POLLINGINT PINT

  • 5000

  • Any positive integer

PORT  

  • 1414 - This is the default value if TRANSPORT is set to CLIENT.

  • 1506 - This is the default value if TRANSPORT is set to DIRECT or DIRECTHTTP.

  • Any positive integer

PRIORITY PRI

  • APP - Priority is defined by the JMS application.

  • QDEF - Priority takes the value of the queue default.

  • Any integer in the range 0-9.

PROCESSDURATION PROCDUR

  • UNKNOWN - A subscriber can give no guarantee about how quickly it can process any message it receives.

  • SHORT - A subscriber guarantees to process quickly any message it receives before returning control to the WebSphere MQ JMS client.

PROXYHOSTNAME PHOST

  • Not set

  • The host name of the proxy server

PROXYPORT PPORT

  • 443

  • The port number of the proxy server

PUBACKINT PAI

  • 25

  • Any positive integer

QMANAGER QMGR Any string
QUEUE QU Any string
RECEIVEISOLATION RCVISOL

  • COMMITTED - A subscriber receives only those messages on the subscriber queue that have been committed.

  • UNCOMMITTED5 - A subscriber can receive messages that have not been committed on the subscriber queue.

RECEXIT RCX

  • Not set

  • A string comprising one or more items separated by commas, where each item is one of the following:

    • The name of a class that implements the WebSphere MQ base Java interface, MQReceiveExit (for a channel receive exit written in Java)

    • A string in the format libraryName(entryPointName) (for a channel receive exit not written in Java)

RECEXITINIT RCXI

  • Not set

  • A string comprising one or more items of user data separated by commas

RESCANINT RINT

  • 5000

  • Any positive integer

SECEXIT SCX

  • Not set

  • The name of a class that implements the WebSphere MQ base Java interface, MQSecurityExit (for a channel security exit written in Java)

  • A string in the format libraryName(entryPointName) (for a channel security exit not written in Java)

SECEXITINIT SCXI

  • Not set

  • Any string

SENDEXIT SDX

  • Not set

  • A string comprising one or more items separated by commas, where each item is one of the following:

    • The name of a class that implements the WebSphere MQ base Java interface, MQSendExit (for a channel send exit written in Java)

    • A string in the format libraryName(entryPointName) (for a channel send exit not written in Java)

SENDEXITINIT SDXI

  • Not set

  • A string comprising one or more items of user data separated by commas

SPARSESUBS SSUBS

  • NO - Subscriptions receive frequent matching messages.

  • YES - Subscriptions receive infrequent matching messages. This value requires that the subscription queue can be opened for browse.

SSLCIPHERSUITE SCPHS

SSLCRL SCRL

SSLFIPSREQUIRED SFIPS

  • NO - An SSL connection can use any CipherSuite that is not supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS).

  • YES - An SSL connection must use a CipherSuite that is supported by IBMJSSEFIPS.

SSLPEERNAME SPEER

SSLRESETCOUNT SRC

  • 0

  • Zero, or any positive integer less than or equal to 999 999 999. See SSL properties

STATREFRESHINT SRI

  • 60 000

  • Any positive integer

SUBSTORE SS

  • MIGRATE

  • QUEUE

  • BROKER

SYNCPOINTALLGETS SPAG

  • No

  • Yes

TARGCLIENT TC

  • JMS - The target of the message is a JMS application.

  • MQ - The target of the message is a non-JMS WebSphere MQ application.

TARGCLIENTMATCHING TCM

  • YES - If an incoming message does not have an MQRFH2 header, the TARGCLIENT property of the Queue object derived from the JMSReplyTo header field of the message is set to MQ. If the message does have an MQRFH2 header, the TARGCLIENT property is set to JMS instead.

  • NO - The TARGCLIENT property of the Queue object derived from the JMSReplyTo header field of an incoming message is always set to JMS.

TEMPMODEL TM

  • SYSTEM.DEFAULT.MODEL.QUEUE

  • Any string

TEMPQPREFIX TQP Any string
TOPIC TOP Any string
TRANSPORT TRAN

  • BIND - For a bindings connection

  • CLIENT - For a client connection

  • DIRECT - For a direct connection to a broker of WebSphere MQ Event Broker, WebSphere Business Integration Event Broker, or WebSphere Business Integration Message Broker

  • DIRECTHTTP - For a direct connection using HTTP tunnelling.

USECONNPOOLING UCP

  • Yes

  • No

  1. The CCDTURL and CHANNEL properties of an object cannot both be set at the same time.

  2. Running two or more instances of the same durable topic subscriber simultaneously contravenes the Java Message Service Specification, Version 1.1.

  3. The binding options, STANDARD, SHARED, ISOLATED, and FASTPATH, are ignored if the application connects in client mode. The SHARED, ISOLATED, and FASTPATH options are ignored by a queue manager running on z/OS. The connection tag options, SERIALQM, SERIALQSG, RESTRICTQM, and RESTRICTQSG, are supported only by a queue manager running on z/OS. For a more detailed explanation of the connection options, see the WebSphere MQ Application Programming Reference.

  4. If you specify NO, and a message is rolled back after the WebSphere MQ JMS client has returned control to the subscriber, the subscriber still retains a copy of the message but is not informed of the rollback. In this situation, a subscriber might receive the same message more than once.

  5. The value UNCOMMITTED has an effect only if PROCESSDURATION has the value SHORT. It has no effect if PROCESSDURATION has the value UNKNOWN. If you specify UNCOMMITTED, ensure that a subscriber acknowledges or commits each message individually.

Many of the properties are relevant only to a specific subset of the object types. Table 2 shows for each property which object types are valid, and gives a brief description of each property. The object types are identified using keywords; refer to Table 1 for an explanation of these.

Numbers refer to notes at the end of the table. See also Property dependencies. Mapping between administration tool properties and programmable properties shows the relationship between properties set by the tool and programmable properties.

The valid combinations of property and object type
Property CF1 QCF TCF Q T XACF1 XAQCF XATCF Description
BROKERCCDURSUBQ         Y       The name of the queue from which durable subscription messages are retrieved for a ConnectionConsumer
BROKERCCSUBQ Y   Y     Y   Y The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer
BROKERCONQ Y   Y     Y   Y Broker's control queue name
BROKERDURSUBQ         Y       The name of the queue from which durable subscription messages are retrieved
BROKERPUBQ Y   Y   Y Y   Y The name of the queue where published messages are sent (the stream queue)
BROKERPUBQMGR         Y       The name of the queue manager that owns the queue where messages published on the topic are sent
BROKERQMGR Y   Y     Y   Y The name of the queue manager on which the broker is running
BROKERSUBQ Y   Y     Y   Y The name of the queue from which non-durable subscription messages are retrieved
BROKERVER Y2   Y2   Y Y   Y The version of the broker being used
CCDTURL3 Y Y Y     Y Y Y 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 Y Y Y Y Y Y Y Y The coded-character-set-ID to be used on connections
CHANNEL3 Y Y Y     Y Y Y The name of the client connection channel being used
CLEANUP Y   Y     Y   Y Cleanup Level for BROKER or MIGRATE Subscription Stores
CLEANUPINT Y   Y     Y   Y The interval between background executions of the publish/subscribe cleanup utility
CLIENTID Y2 Y Y2     Y Y Y A string identifier for the client
CLONESUPP Y   Y     Y   Y Whether two or more instances of the same durable topic subscriber can run simultaneously
COMPHDR Y Y Y     Y Y Y A list of the techniques that can be used for compressing header data on a connection
COMPMSG Y Y Y     Y Y Y A list of the techniques that can be used for compressing message data on a connection
CONNOPT Y Y Y     Y Y Y Options that control how the application connects to the queue manager
CONNTAG4 Y Y Y     Y Y Y 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 Y2 Y Y2 Y Y Y Y Y A description of the stored object
DIRECTAUTH Y   Y           To enable SSL authentication for a direct connection5
ENCODING       Y Y       The encoding scheme used for this destination
EXPIRY       Y Y       The period after which messages at a destination expire
FAILIFQUIESCE Y Y Y Y Y Y Y Y Whether calls to certain methods fail if the queue manager is in a quiescing state
HOSTNAME Y2 Y Y2     Y Y Y The host name or IP address of the system on which the queue manager resides or, for a direct connection to a broker, the system on which the broker resides
LOCALADDRESS Y Y Y     Y Y Y For a connection to a queue manager, this property specifies either or both of the following:

  • The local network interface to be used

  • The local port, or range of local ports, to be used

For a direct connection to a broker, this property is relevant only when multicast is used, and specifies the local network interface to be used.

MAPNAMESTYLE Y Y Y           Determines how the body of a map message is encoded when the message is sent.
MAXBUFFSIZE Y   Y         Y 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 value DIRECT or DIRECTHTTP.
MSGBATCHSZ Y Y Y     Y Y Y The maximum number of messages to be taken from a queue in one packet when using asynchronous message delivery
MSGRETENTION Y Y       Y Y   Whether or not the connection consumer keeps unwanted messages on the input queue
MSGSELECTION Y   Y     Y   Y Determines whether message selection is done by the JMS client 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 Y   Y   Y       To enable multicast transport on a direct connection and, if enabled, to specify the precise way in which multicast transport 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 the broker.5
OPTIMISTICPUBLICATION Y   Y           Whether the WebSphere MQ JMS client returns control immediately to a publisher that has just 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 Y   Y           Whether the WebSphere MQ JMS client returns 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       Y Y       The persistence of messages sent to a destination
POLLINGINT Y Y Y     Y Y Y 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 Y2 Y Y2     Y Y Y The port on which the queue manager or broker listens
PRIORITY       Y Y       The priority for messages sent to a destination
PROCESSDURATION Y   Y           Whether a subscriber guarantees to process quickly any message it receives before returning control to the WebSphere MQ JMS client
PROXYHOSTNAME Y   Y           The host name of the proxy server for a direct connection5
PROXYPORT Y   Y           The port number of the proxy server for a direct connection5
PUBACKINT Y   Y     Y   Y The number of messages published by a publisher before the WebSphere MQ JMS client requests an acknowledgement from the broker. If you lower the value of this property, the client requests acknowledgements more often, and therefore the performance of the publisher decreases. If you raise the value, the client takes a longer time to throw an exception if the broker fails. This property is relevant only if TRANSPORT has the value BIND or CLIENT.
QMANAGER Y Y Y Y   Y Y Y The name of the queue manager to connect to. But, if your application uses a client channel definition table to connect to a queue manager, see Using a client channel definition table.
QUEUE       Y         The underlying name of the queue representing this destination
RECEIVEISOLATION Y   Y           Whether a subscriber might receive messages that have not been committed on the subscriber queue
RECEXIT Y Y Y     Y Y Y Identifies a channel receive exit, or a sequence of receive exits to be run in succession
RECEXITINIT Y Y Y     Y Y Y The user data that is passed to channel receive exits when they are called
RESCANINT Y Y       Y Y   When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, the WebSphere MQ JMS client searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. When the client finds a suitable message and delivers it to the consumer, the client resumes the search for the next suitable message from its current position in the queue. The client continues to search the queue in this way until it reaches the end of the queue, or until the interval of time in milliseconds, as determined by the value of this property, has expired. In each case, the client returns to the beginning of the queue to continue its search, and a new time interval commences.
SECEXIT Y Y Y     Y Y Y Identifies a channel security exit
SECEXITINIT Y Y Y     Y Y Y The user data that is passed to a channel security exit when it is called
SENDEXIT Y Y Y     Y Y Y Identifies a channel send exit, or a sequence of send exits to be run in succession
SENDEXITINIT Y Y Y     Y Y Y The user data that is passed to channel send exits when they are called
SPARSESUBS Y   Y           Controls the message retrieval policy of a TopicSubscriber object
SSLCIPHERSUITE Y Y Y     Y Y Y The CipherSuite to use for an SSL connection
SSLCRL Y Y Y     Y Y Y CRL servers to check for SSL certificate revocation
SSLFIPSREQUIRED Y Y Y     Y Y Y Whether an SSL connection must use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS)
SSLPEERNAME Y Y Y     Y Y Y For SSL, a distinguished name skeleton that must match that provided by the queue manager
SSLRESETCOUNT Y Y Y     Y Y Y For SSL, the total number bytes sent and received by a connection before the secret key that is used for encryption is renegotiated.
STATREFRESHINT Y   Y     Y   Y The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if SUBSTORE has the value QUEUE. For more information about setting this property, see Subscription stores.
SUBSTORE Y   Y     Y   Y Where WebSphere MQ JMS should store persistent data relating to active subscriptions
SYNCPOINTALLGETS Y Y Y     Y Y Y Whether all gets should be performed under syncpoint
TARGCLIENT6       Y Y       Whether the WebSphere MQ RFH2 format is used to exchange information with target applications
TARGCLIENTMATCHING Y Y       Y Y   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 Y Y       Y Y   The name of the model queue from which JMS temporary queues are created
TEMPQPREFIX Y Y       Y Y   The prefix that is used to form the name of a WebSphere MQ dynamic queue. The rules for forming the prefix are the same as those for forming the contents of the DynamicQName field in a WebSphere MQ object descriptor, structure MQOD, but the last non blank character must be an asterisk. If no value is specified for the property, the value used is CSQ.* on z/OS and AMQ.* on the other platforms.
TOPIC         Y       The underlying name of the topic representing this destination
TRANSPORT Y2 Y Y2     Y Y Y Whether a connection uses bindings or client mode to connect to a queue manager, or whether it is a direct connection to a broker
USECONNPOOLING Y Y Y     Y Y Y Whether to use connection pooling

  1. This object type applies to JMS 1.1 only.

  2. Only the BROKERVER, CLIENTID, DESCRIPTION, HOSTNAME, LOCALADDRESS, PORT, and TRANSPORT properties are supported for a TopicConnectionFactory object, or a JMS 1.1 domain independent ConnectionFactory object, when connecting directly to a broker.

  3. The CCDTURL and CHANNEL properties of an object cannot both be set at the same time.

  4. The CONNTAG property is supported only by a queue manager running on z/OS.

  5. See Connecting to other products.

  6. The TARGCLIENT property indicates whether the WebSphere MQ RFH2 format is used to exchange information with target applications.

    The MQJMS_CLIENT_JMS_COMPLIANT constant indicates that the RFH2 format is used to send information. Applications that use WebSphere MQ JMS understand the RFH2 format. Set the MQJMS_CLIENT_JMS_COMPLIANT constant when you exchange information with a target WebSphere MQ JMS application.

    The MQJMS_CLIENT_NONJMS_MQ constant indicates that the RFH2 format is not used to send information. Typically, this value is used for an existing WebSphere MQ application (that is, one that does not handle RFH2).


uj10910_