MQPutMessageOptions

java.lang.Object
   |
   *- com.ibm.mq.MQPutMessageOptions

This class contains options that control the behavior of MQQueue.put().

Note:

The behavior of some of the options available in this class depends on the environment in which they are used. These elements are marked with a *. See Chapter 8, Environment-dependent behavior for more details.

Variables

contextReference

public MQQueue ContextReference

This is an input field which indicates the source of the context information.

If the options field includes MQC.MQPMO_PASS_IDENTITY_CONTEXT, or MQC.MQPMO_PASS_ALL_CONTEXT, set this field to refer to the MQQueue from which the context information should be taken.

The initial value of this field is null.

invalidDestCount *

public int invalidDestCount

This is an output field set by the queue manager to the number of messages that could not be sent to queues in a distribution list. The count includes queues that failed to open as well as queues that were opened successfully, but for which the put operation failed. This field is also set when opening a single queue that is not part of a distribution list.

knownDestCount *

public int knownDestCount

This is an output field set by the queue manager to the number of messages that the current call has sent successfully to queues that resolve to local queues. This field is also set when opening a single queue that is not part of a distribution list.

options

public int options

Options that control the action of MQQueue.put. Any or none of the following values can be specified. If more than one option is required the values can be added together or combined using the bitwise OR operator.

MQC.MQPMO_DEFAULT_CONTEXT

Associate default context with the message.

MQC.MQPMO_FAIL_IF_QUIESCING

Fail if the queue manager is quiescing.

MQC.MQPMO_LOGICAL_ORDER*

Put logical messages and segments in message groups into their logical order.

MQC.MQPMO_NEW_CORREL_ID*

Generate a new correlation id for each sent message.

MQC.MQPMO_NEW_MSG_ID*

Generate a new message id for each sent message.

MQC.MQPMO_NONE

No options specified. Do not use in conjunction with other options.

MQC.MQPMO_NO_CONTEXT

No context is to be associated with the message.

MQC.MQPMO_NO_SYNCPOINT

Put a message without syncpoint control. Note that, if the syncpoint control option is not specified, a default of 'no syncpoint' is assumed. This applies for all supported platforms, including z/OS.

MQC.MQPMO_PASS_ALL_CONTEXT

Pass all context from an input queue handle.

MQC.MQPMO_PASS_IDENTITY_CONTEXT

Pass identity context from an input queue handle.

MQC.MQPMO_SET_ALL_CONTEXT

Set all context from the application.

MQC.MQPMO_SET_IDENTITY_CONTEXT

Set identity context from the application.

MQC.MQPMO_SYNCPOINT

Put a message with syncpoint control. The message is not visible outside the unit of work until the unit of work is committed. If the unit of work is backed out, the message is deleted.

recordFields *

public int recordFields

Flags indicating which fields are to be customized on a per-queue basis when putting a message to a distribution list. One or more of the following flags can be specified:

MQC.MQPMRF_ACCOUNTING_TOKEN

Use the accountingToken attribute in the MQDistributionListItem.

MQC.MQPMRF_CORREL_ID

Use the correlationId attribute in the MQDistributionListItem.

MQC.MQPMRF_FEEDBACK

Use the feedback attribute in the MQDistributionListItem.

MQC.MQPMRF_GROUP_ID

Use the groupId attribute in the MQDistributionListItem.

MQC.MQPMRF_MSG_ID

Use the messageId attribute in the MQDistributionListItem.

The special value MQC.MQPMRF_NONE indicates that no fields are to be customized.

resolvedQueueManagerName

public String resolvedQueueManagerName

This is an output field set by the queue manager to the name of the queue manager that owns the queue specified by the remote queue name. This may be different from the name of the queue manager from which the queue was accessed if the queue is a remote queue.

resolvedQueueName

public String resolvedQueueName

This is an output field that is set by the queue manager to the name of the queue on which the message is placed. This may be different from the name used to open the queue if the opened queue was an alias or model queue.

unknownDestCount *

public int unknownDestCount

This is an output field set by the queue manager to the number of messages that the current call has sent successfully to queues that resolve to remote queues. This field is also set when opening a single queue that is not part of a distribution list.

Constructors

MQPutMessageOptions

public MQPutMessageOptions()

Construct a new MQPutMessageOptions object with no options set, and a blank resolvedQueueName and resolvedQueueManagerName.