com.ibm.mq
Class MQPutMessageOptions
- java.lang.Object
-
- com.ibm.mq.jmqi.JmqiObject
-
- com.ibm.mq.MQPutMessageOptions
-
public class MQPutMessageOptions extends com.ibm.mq.jmqi.JmqiObject
This class contains options that control the behavior ofMQQueue.put
.
-
-
Field Summary
Fields Modifier and Type Field and Description MQQueue
contextReference
An input field that indicates the source of the context information.int
contextReferenceHandle
Handle to the context referenceint
invalidDestCount
Number of messages that could not be sent.int
knownDestCount
Number of messages successfully sent to local queues.int
options
Options that control the action ofMQQueue.put()
.int
recordFields
Flag that controls the behavior of MQPUT when used with distribution lists.java.lang.String
resolvedQueueManagerName
An output field set by the queue manager to the name of the queue manager that owns the remote queue.java.lang.String
resolvedQueueName
The output field set by the queue manager to the name of the queue on which the message is placed.int
unknownDestCount
Number of messages successfully sent to remote queues.
-
Constructor Summary
Constructors Constructor and Description MQPutMessageOptions()
Constructs an object with no options set, and blank resolvedQueueName and resolvedQueueManagerName.MQPutMessageOptions(boolean noReadBack)
Constructs an MQPutMessageOptions object; reading theoptions
field is optional.
-
-
-
Field Detail
-
options
public int options
Options that control the action ofMQQueue.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
CMQC.MQPMO_NO_SYNCPOINT
for all platforms.CMQC.MQPMO_SYNCPOINT
CMQC.MQPMO_NO_SYNCPOINT
- defaultCMQC.MQPMO_NO_CONTEXT
CMQC.MQPMO_DEFAULT_CONTEXT
CMQC.MQPMO_SET_IDENTITY_CONTEXT
CMQC.MQPMO_SET_ALL_CONTEXT
CMQC.MQPMO_FAIL_IF_QUIESCING
CMQC.MQPMO_NEW_MSG_ID
CMQC.MQPMO_NEW_CORREL_ID
CMQC.MQPMO_LOGICAL_ORDER
CMQC.MQPMO_ALTERNATE_USER_AUTHORITY
CMQC.MQPMO_RESOLVE_LOCAL_Q
CMQC.MQPMO_ASYNC_RESPONSE
-
contextReferenceHandle
public int contextReferenceHandle
Handle to the context reference
-
contextReference
public MQQueue contextReference
An input field that indicates the source of the context information. If the options field includesCMQC.MQPMO_PASS_IDENTITY_CONTEXT
orCMQC.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
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.
-
resolvedQueueManagerName
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.
-
knownDestCount
public int knownDestCount
Number of messages successfully sent to local queues.
-
unknownDestCount
public int unknownDestCount
Number of messages successfully sent to remote queues.
-
invalidDestCount
public int invalidDestCount
Number of messages that could not be sent.
-
recordFields
public int recordFields
Flag that controls the behavior of MQPUT when used with distribution lists.
-
-
Constructor Detail
-
MQPutMessageOptions
public MQPutMessageOptions()
Constructs an object with no options set, and blank resolvedQueueName and resolvedQueueManagerName.
-
MQPutMessageOptions
public MQPutMessageOptions(boolean noReadBack)
Constructs an MQPutMessageOptions object; reading theoptions
field 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.
-
-