com.ibm.mq

Class MQPutMessageOptions

  1. java.lang.Object
  2. extended bycom.ibm.mq.jmqi.JmqiObject
  3. extended bycom.ibm.mq.MQPutMessageOptions
  1. public class MQPutMessageOptions
  2. extends com.ibm.mq.jmqi.JmqiObject
This class contains options that control the behavior of MQQueue.put.

Field Summary

Modifier and Type Field and Description
  1. MQQueue
 contextReference
An input field that indicates the source of the context information.
  1. int
 contextReferenceHandle
Handle to the context reference
  1. int
 invalidDestCount
Number of messages that could not be sent.
  1. int
 knownDestCount
Number of messages successfully sent to local queues.
  1. int
 options
Options that control the action of MQQueue.put().
  1. int
 recordFields
Flag that controls the behavior of MQPUT when used with distribution lists.
  1. java.lang.String
 resolvedQueueManagerName
An output field set by the queue manager to the name of the queue manager that owns the remote queue.
  1. java.lang.String
 resolvedQueueName
The output field set by the queue manager to the name of the queue on which the message is placed.
  1. int
 unknownDestCount
Number of messages successfully sent to remote queues.
Fields inherited from class com.ibm.mq.jmqi.JmqiObject
COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructor and Description
MQPutMessageOptions()
Constructs an object with no options set, and blank resolvedQueueName and resolvedQueueManagerName.
MQPutMessageOptions(boolean noReadBack)
Constructs an MQPutMessageOptions object; reading the optionsfield is optional.

Method Summary

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

options

  1. 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 combined using '&' or '|'.

Note that the default syncpoint is MQC.MQPMO_NO_SYNCPOINT for all platforms.

contextReferenceHandle

  1. public int contextReferenceHandle
Handle to the context reference

contextReference

  1. public MQQueue contextReference
An input field that 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 to take the context information. The initial value of this field is null.

resolvedQueueName

  1. public java.lang.String resolvedQueueName
The output field set by the queue manager to the name of the queue on which the message is placed. This might be different from the name used to open the queue, if the opened queue was an alias or model queue.
See Also:
MQC.MQOO_RESOLVE_LOCAL_Q, MQC.MQPMO_RESOLVE_LOCAL_Q

resolvedQueueManagerName

  1. public java.lang.String resolvedQueueManagerName
An output field set by the queue manager to the name of the queue manager that owns the remote queue. This might be different from the name of the queue manager from which the queue was accessed if the queue is a remote queue.
See Also:
MQC.MQOO_RESOLVE_LOCAL_Q, MQC.MQPMO_RESOLVE_LOCAL_Q

knownDestCount

  1. public int knownDestCount
Number of messages successfully sent to local queues.

unknownDestCount

  1. public int unknownDestCount
Number of messages successfully sent to remote queues.

invalidDestCount

  1. public int invalidDestCount
Number of messages that could not be sent.

recordFields

  1. public int recordFields
Flag that controls the behavior of MQPUT when used with distribution lists.

Constructor Detail

MQPutMessageOptions

  1. public MQPutMessageOptions()
Constructs an object with no options set, and blank resolvedQueueName and resolvedQueueManagerName.

MQPutMessageOptions

  1. public MQPutMessageOptions(boolean noReadBack)
Constructs an MQPutMessageOptions object; reading the optionsfield is optional. You can use this constructor to save some overheads if your application never needs to read back the options field.
Parameters:
noReadBack - if true this disables the reading back the options MQPMO field. This avoids the overhead of converting it.