Package com.ibm.mq

Class MQPropertyDescriptor

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.MQPropertyDescriptor
public class MQPropertyDescriptor extends com.ibm.mq.jmqi.JmqiObject
An MQPropertyDescriptor instance is used to describe a property of an MQMessage. It encapsulates a property descriptor structure (MQPD). This class is an input parameter on the MQMessage#set*Property() calls and an output parameter on the MQMessage.get*Property() calls.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    context
    This describes the message context the property belongs to.
    int
    copyOptions
    This describes which type of messages the property should be copied into.
    int
    options
    Message Property's Options.
    int
    support
    This field describes what level of support for the message property is required of the queue manager in order for the message containing this property to be put to a queue.
    int
    version
    This is the structure version number; the value must be:MQPD_VERSION_1

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

    COMP_JM, COMP_JN, COMP_JO

  • Constructor Summary

    Constructors
    Constructor
    Description
    MQPropertyDescriptor()
    Default constructor

  • 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

    • context

      public int context
      This describes the message context the property belongs to. Any of the following can be specified
    • CMQC.MQPD_USER _CONTEXT
    • CMQC.MQPD_NO_CONTEXT

    • copyOptions

      public int copyOptions
      This describes which type of messages the property should be copied into. Any of the following can be specified. If more than one is required the values can be: - Added together (do not add the same constant more than once), or - Combined using the bitwise OR operation (if the programming language supports bit operations). Any or none of the following values can be specified
    • CMQC.MQCOPY_FORWARD
    • CMQC.MQCOPY_PUBLISH
    • CMQC.MQCOPY_REPLY
    • CMQC.MQCOPY_REPORT
    • CMQC.MQCOPY_ALL
    • CMQC.MQCOPY_DEFAULT
    • CMQC.MQCOPY_NONE

    • options

      public int options
      Message Property's Options. This is always an input field. The initial value of this field is MQPD_NONE.
    • CMQC.MQPD_NONE

    • support

      public int support
      This field describes what level of support for the message property is required of the queue manager in order for the message containing this property to be put to a queue. This only applies to MQ-defined properties; support for all other properties is optional Any or none of the following values can be specified
    • CMQC.MQPD_SUPPORT_OPTIONAL
    • CMQC.MQPD_SUPPORT_REQUIRED
    • CMQC.MQPD_SUPPORT_REQUIRED_IF_LOCAL

    • version

      public int version
      This is the structure version number; the value must be:MQPD_VERSION_1

  • Constructor Details

    • MQPropertyDescriptor

      public MQPropertyDescriptor()
      Default constructor