Package com.ibm.mq

Class MQGetMessageOptions

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.MQGetMessageOptions

public class MQGetMessageOptions
extends com.ibm.mq.jmqi.JmqiObject

This class contains options which control the behaviour of MQQueue.get().

Field Summary

Fields

Modifier and Type	Field	Description
char	groupStatus	Whether the retrieved message is in a group, and if it is, whether it is the last in the group.
int	matchOptions	Selection criteria that determine which message is retrieved.
byte[]	msgToken	A token for use when getting messages.
int	options	Options that control the action of MQQueue.get().
String	resolvedQueueName	The local name of the queue from which the message was retrieved.
int	returnedLength	The length in bytes of the message data.
char	segmentation	Whether segmentation is allowed for the retrieved message.
char	segmentStatus	Whether the retrieved message is a segment of a logical message.
int	waitInterval	The maximum time (in milliseconds) that an MQQueue.get() call waits for a suitable message to arrive.

Fields inherited from class com.ibm.mq.jmqi.JmqiObject

COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructors

Constructor	Description
MQGetMessageOptions()	Constructs an MQGetMessageOptions object with options set to MQConstants.MQGMO_MO_WAIT, a wait interval of zero, and a blank resolved queue name.
MQGetMessageOptions(boolean noReadBack)	Constructs an MQGetMessageOptions object with an option on reading options field.

Method Summary

Methods inherited from class com.ibm.mq.jmqi.JmqiObject

getJmqiEnvironment

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

options

public int options

Options that control the action of MQQueue.get(). Any or none of the following values can be specified. If more than one option is required the values can combined using either '+' or '|'.

• MQConstants.MQGMO_WAIT
• MQConstants.MQGMO_NO_WAIT
• MQConstants.MQGMO_SYNCPOINT
• MQConstants.MQGMO_NO_SYNCPOINT- default
• MQConstants.MQGMO_BROWSE_FIRST
• MQConstants.MQGMO_BROWSE_NEXT
• MQConstants.MQGMO_BROWSE_MSG_UNDER_CURSOR
• MQConstants.MQGMO_MSG_UNDER_CURSOR
• MQConstants.MQGMO_LOCK
• MQConstants.MQGMO_UNLOCK
• MQConstants.MQGMO_ACCEPT_TRUNCATED_MSG
• MQConstants.MQGMO_FAIL_IF_QUIESCING
• MQConstants.MQGMO_CONVERT

waitInterval

public int waitInterval

The maximum time (in milliseconds) that an MQQueue.get() call waits for a suitable message to arrive. It is used in conjunction with MQConstants.MQGMO_WAIT. A value of MQConstants.MQWI_UNLIMITED indicates that an unlimited wait is required.

resolvedQueueName

public String resolvedQueueName

The local name of the queue from which the message was retrieved. This is the resolved name as set by the queue manager. It is different from the name used to open the queue, if an alias queue or model queue was opened.

msgToken

public byte[] msgToken

A token for use when getting messages. It is set either by the queue manager or by the application in combination with MQMO_MATCH_MSG_TOKEN. The token is truncated if its size is greater than MQConstants.MQ_MSG_TOKEN_LENGTH. It is ignored if it has been set without the corresponding matchOption being set. If matchOption is set for a platform other than z/OS an attempted get will fail.

returnedLength

public int returnedLength

The length in bytes of the message data. It is set by the queue manager to the value returned by the MQGET call. If the queue manager does not support this capability, the value is set to MQConstants.MQRL_UNDEFINED.

matchOptions

public int matchOptions

Selection criteria that determine which message is retrieved. The following match options can be set:

• MQConstants.MQMO_MATCH_CORREL_ID
• MQConstants.MQMO_MATCH_GROUP_ID
• MQConstants.MQMO_MATCH_MSG_ID
• MQConstants.MQMO_MATCH_MSG_SEQ_NUMBER
• MQConstants.MQMO_NONE

The default value is MQConstants.MQMO_MATCH_MSG_ID | MQConstants.MQMO_MATCH_CORREL_ID.

groupStatus

public char groupStatus

Whether the retrieved message is in a group, and if it is, whether it is the last in the group. Possible values are:

• MQConstants.MQGS_LAST_MSG_IN_GROUP
• MQConstants.MQGS_MSG_IN_GROUP
• MQConstants.MQGS_NOT_IN_GROUP

segmentStatus

public char segmentStatus

Whether the retrieved message is a segment of a logical message. If the message is a segment, this field also indicates whether or not it is the last segment. Possible values are:

• MQConstants.MQSS_LAST_SEGMENT
• MQConstants.MQSS_NOT_A_SEGMENT
• MQConstants.MQSS_SEGMENT

segmentation

public char segmentation

Whether segmentation is allowed for the retrieved message. Possible values are:

• MQConstants.MQSEG_INHIBITED
• MQConstants.MQSEG_ALLOWED

Constructor Details

MQGetMessageOptions

public MQGetMessageOptions()

Constructs an MQGetMessageOptions object with options set to MQConstants.MQGMO_MO_WAIT, a wait interval of zero, and a blank resolved queue name.

MQGetMessageOptions

public MQGetMessageOptions(boolean noReadBack)

Constructs an MQGetMessageOptions object with an option on reading options field. You can use this constructor to save some overheads if your application never needs to read back the options field.

Parameters:

noReadBack - if true , prevents the options MQGMO field from being read back. This means that the overhead of converting it is avoided.