Destination properties
The following tables list all the properties that you can set for destinations:
For each property, there is a brief description of when you might need to configure the property. The tables also give the equivalent long and short names to use in the JMS Administration command line tool. The properties that are available in the Properties dialog depend on the type of destination; queue destinations have some different properties from topic destinations. For more information, see Using the WebSphere MQ JMS administration tool in the IBM® online IBM WebSphere® MQ product documentation.
General page
The following table lists the properties that you can set on the General page of the Destination properties dialog.
| Property | Meaning | Long name | Short name |
|---|---|---|---|
| Name | This shows the name of the object. | NAME | |
| Description | Type a description of the object. | DESCRIPTION | DESC |
| Class name | This shows the class name that is implemented by the destination. | ||
| Messaging provider | This shows the transport that is supported by the destination object. The value is: WebSphere MQ and Real-time transport. | ||
| Queue manager | Select or type the name of the queue manager that hosts the destination queue. | QMANAGER | QMGR |
| Queue | Select the name of the queue that is represented by the destination. | QUEUE | QU |
| Topic | Type the name of the topic that this destination represents. | TOPIC | TOP |
Message handling page
The following table lists the properties that you can set on the Message handling page of the Destination properties dialog. Edit the properties on the Message handling page to configure what happens to messages that are sent to the destination.
| Property | Meaning | Long name | Short name |
|---|---|---|---|
| Expiry | Specify the period after which messages at the destination expire. To specify that expiry can be defined by the JMS client application, click Application. To specify that no expiry occurs, click Unlimited. Otherwise, type the number of milliseconds before the messages expire. | EXPIRY | EXP |
| Persistence | Specify the persistence of messages sent to the destination. To specify that the persistence is defined by the JMS application, click Application. To specify that the persistence takes the value of the queue's default value, click Queue default. To specify that messages are persistent, click Persistent. To specify that messages are not persistent, click Not persistent. To specify that nonpersistent messages on the queue are not discarded when the queue manager restarts following a quiesced or immediate shutdown, click High (nonpersistent messages might be discarded, however, following a preemptive shutdown or a failure). | PERSISTENCE | PER |
| Priority | Specify the priority for messages sent to the destination. To specify that the priority is defined by the JMS client application, click Application. To specify that the priority takes the value of the queue default, click Queue default. Otherwise, type the priority, from 0-9. | PRIORITY | PRI |
| MQMD Message Context | Specify the context when sending
messages to a destination. There are three options to choose from: Default: The MQOPEN API call and the MQPMO structure will specify no explicit message context options. This is the default value. Set All Context: The MQOPEN API call specifies the message context option MQOO_SET_ALL_CONTEXT and the MQPMO structure specifies MQPMO_SET_ALL_CONTEXT.Set Identity Context: The MQOPEN API call specifies the message context option MQOO_SET_IDENTITY_CONTEXT and the MQPMO structure specifies MQPMO_SET_IDENTITY_CONTEXT. |
MDMSGCTX | MDCTX |
| MQMD Write Enabled | Specify whether a JMS application
can set the values of MQMD fields. There are two options to choose
from: No: All JMS_IBM_MQMD* properties are ignored and their values are not copied into the underlying MQMD structure. This is the default value. Yes: All JMS_IBM_MQMD* properties are processed. Their values are copied into the underlying MQMD structure. |
MDWRITE | MDW |
| MQMD Read Enabled | Specify whether a JMS application
can extract the values of MQMD fields. There are two options to choose
from: No: When sending messages, the JMS_IBM_MQMD* properties on a sent message are not updated to reflect the updated field values in the MQMD. When receiving messages, none of the JMS_IBM_MQMD* properties are available on a received message, even if the sender had set some or all of them. This is the default value. Yes: When sending messages, all of the JMS_IBM_MQMD* properties on a sent message are updated to reflect the updated field values in the MQMD, including those that the sender did not set explcitly. When receiving messages, all of the JMS_IBM_MQMD* properties are available on a received message, including those that the sender did not set explicitly. |
MDREAD | MDR |
| Message Body | Specify whether a JMS application
processes the MQRFH2 of a WebSphere MQ message as part of the JMS
message body. There are three options to choose from: Unspecified: When sending messages; WebSphere MQ classes for JMS does or does not generate and include an MQRFH2 header, depending on the value of WMQ_TARGET_CLIENT. When receiving messages; it acts as if the value is set to JMS. This is the default value. JMS: When sending messages; WebSphere MQ classes for JMS automatically generates an MQRFH2 header and includes it in the WebSphere MQ message. When receiving messages; WebSphere MQ classes for JMS set the JMS message properties according to values in the MQRFH2 (if present); it does not present the MQRFH2 as part of the JMS message body.MQ: When sending messages; WebSphere MQ classes for JMS does not generate an MQRFH2. When receiving messages; WebSphere MQ classes for JMS presents the MQRFH2 as part of the JMS message body. |
MSGBODY | MBODY |
| Receive conversion | Configures use of MQGMO_CONVERT optioN. When requesting messages, selects if conversion is to be carried out in the queue manager by specifying MQGMO_CONVERT on the MQGET, or in the client application. | RECEIVECONVERSION | RCNV |
| Receive CCSID | Requested CCSID to convert the message to. Used when the WebSphere MQ classes for JMS are requesting the queue manager to perform conversion (for example by specifying WMQ_RECEIVE_CONVERSION_QMGR as the argument to setReceiveConversion). The value of this property is the CCSID which the queue manager is requested to convert the message to. The default value is CCSID 1208. | RECEIVECCSID | RCCS |
Broker page
The following table lists the properties that you can set on the Broker page of the Destination properties dialog. Edit the properties on the Broker page to provide details of the publish/subscribe broker.
| Property | Meaning | Long name | Short name |
|---|---|---|---|
| Broker durable subscription queue | This property can be used in a WebSphere MQ Version 7.0 JMS client but has no effect on a WebSphere MQ Version 7.0 queue manager. It has the effect on earlier versions of the queue manager. If the queue manager that the JMS client is connecting to is the same one that is used by the publish subscribe broker, you can select a queue from the broker queue manager. The selected queue manager must be running. If this is not the case, then you must type the name of the queue from which durable subscription messages are retrieved for. The default queue is SYSTEM.JMS.D.SUBSCRIBER.QUEUE. |
BROKERDURSUBQ | BDSUB |
| Broker CC durable subscription message queue | This property can be used in a WebSphere MQ Version 7.0 JMS client but has no effect on a WebSphere MQ Version 7.0 queue manager If the queue manager that the JMS client is connecting to is the same one that is used by the publish subscribe broker, you can select a queue from the broker queue manager. The selected queue manager must be running. If this is not the case, then you must type the name of the queue from which durable subscription messages are retrieved for a ConnectionConsumer. The default queue is SYSTEM.JMS.D.CC.SUBSCRIBER.QUEUE. |
BROKERCCDURSUBQ | CCDSUB |
| Publication stream | This property can be used in a WebSphere MQ Version 7.0 JMS client but has no effect on a WebSphere MQ Version 7.0 queue manager. Select or type the name of the queue
to which published messages are sent (the stream queue). The default
queue is SYSTEM.BROKER.DEFAULT.STREAM. To use Select to enter the
name, you must have already selected a value for the |
BROKERPUBQ | BPUB |
| Broker publication queue manager | Select or type the name of the queue manager that owns the queue to which messages published on the topic are sent. | BROKERPUBQMGR | BPQM |
| Broker version | This property can be used in a WebSphere MQ Version 7.0 JMS client but has no effect on a WebSphere MQ Version 7.0 queue manager. Select the version of the broker
being used. Click |
BROKERVER | BVER |
Producers page
The following table lists the properties that you can set on the Producers page of the Destination properties dialog. Edit the properties on the Producers page to change further properties of the destination object.
| Property | Meaning | Long name | Short name |
|---|---|---|---|
| Allow asynchronous puts | Specify whether message producers are allowed to use asynchronous puts to send messages to this destination. To determine whether message producers are allowed by referring to the queue or topic definition, click As destination (default). To allow asynchronous puts, click Enabled; to disallow asynchronous puts, click Disabled. | PUTASYNCALLOWED | PAA |
Consumers page
The following table lists the properties that you can set on the Consumers page of the Destination properties dialog. Edit the properties on the Consumers page to change further properties of the destination object.
| Property | Meaning | Long name | Short name |
|---|---|---|---|
| Allow read ahead | Specify whether message consumers and queue browsers are allowed to use read ahead to get non-persistent messages from this destination into a client buffer before receiving them. To determine whether read ahead is allowed by referring to the queue or topic definition, click As destination (default). To allow read ahead, click Enabled; to disallow read ahead, click Disabled. | READAHEADALLOWED | RAA® |
| Read ahead close policy | For messages being delivered to an asynchronous message listener, specify what should happen to messages on the client proxy queue when the message consumer is closed. To specify that all messages on the client proxy queue are delivered to the application's MessageListener before returning, click Deliver all (default). To specify that the current MessageListener invocation only completes before returning, potentially leaving further messages on the client proxy queue to be discarded, click Deliver current. | READAHEADCLOSEPOLICY | RACP |
| Wildcard format | Specify which version of wildcard syntax is
to be used. Click Only character wildcards to use only character wildcards (for consistency with applications that previously used Broker Version 1; see the Broker version property). Click Only topic wildcards to use only topic level wildcards, which are used in Broker Version 2. |
WILDCARDFORMAT | WCFMT |
Extended page
The following table lists the properties that you can set on the Extended page of the Destination properties dialog. Edit the properties on the Extended page to change further properties of the destination object.
| Property | Meaning | Long name | Short name |
|---|---|---|---|
| Coded character set ID | Type the coded character set ID (CCSID) to be used for destinations. | CCSID | CCS |
| Encoding | Select the encoding scheme used for this destination. For more information, see Using the WebSphere MQ JMS administration tool in the IBM online IBM WebSphere MQ product documentation. | ENCODING | ENC |
| Fail if quiesce | Specify whether calls to certain methods fail if the queue manager is in a quiescing state. To specify that calls to certain methods fail if the queue manager is in a quiescing state, click Yes. This means that 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. To specify that no method calls fail because the queue manager is in a quiescing state, click No. This means that an application cannot detect that the queue manager is quiescing, so the application might continue to perform operations against the queue manager and, therefore, prevent the queue manager from stopping. | FAILIFQUIESCE | FIQ |
| Multicast | Specify whether messages are delivered to
message consumers using multicast transport. Multicast transport is
applicable only to topic destinations and can be used only when the
connection factory uses Direct IP transport. The default value is As Connection Factory, which means that the value of the connection factory's Multicast property is used. Click Enabled to deliver messages to the message consumer using multicast transport. The topic must be configured for reliable multicast in the broker; a reliable quality of service is used if the topic is configured for reliable multicast. |
MULTICAST | MCAST |
| Multicast (continued) | Click Reliable to deliver messages to the message consumer using multicast transport with a reliable quality of service. The topic must be configured for reliable multicast, in the broker; if the topic is not configured for reliable multicast, you cannot create a message consumer for the topic. Click Not reliable to deliver messages using multicast transport but without using a reliable quality of service. The topic must be configured for multicast in the broker; a reliable quality of service is not used, even if the topic is configured for reliable multicast. |
MULTICAST | MCAST |
| Target client | Click JMS to specify that the target of the message is a JMS application. Click MQ to specify that the target of the message is a non-JMS WebSphere MQ application. |
TARGCLIENT | TC |
| ReplyTo destination style | Specify the format of the JMSReplyTo field. Click Default to use the default value. The default value is equivalent to the information in the RFH2 unless the JVM system property has been set. Click MQMD to use the value supplied in the MQMD. This will populate the queue manager field with the value from the MQMD, equivalent to the default behaviour of WebSphere MQ Version 6.0.2.4 and 6.0.2.5. Click RFH2 to use the value supplied in the RFH2 header. If the sending application set a JMSReplyTo value then that value will be used. |
REPLYTOSTYLE | RTOST |
| Receive conversion | Configures use of MQGMO_CONVERT option. When requesting messages, selects if conversion is to be carried out in the queue manager by specifying MQGMO_CONVERT on the MQGET, or in the client application. | RECEIVECONVERSION | RCNV |
| Receive CCSID | Requested CCSID to convert the message to. Used when the WebSphere MQ classes for JMS are requesting the queue manager to perform conversion (for example by specifying WMQ_RECEIVE_CONVERSION_QMGR as the argument to setReceiveConversion). The value of this property is the CCSID which the queue manager is requested to convert the message to. The default value is CCSID 1208. | RECEIVECCSID | RCCS |