Class MQXQH

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.headers.MQXQH
All Implemented Interfaces:
MQChainable, MQData, MQHeader
public class MQXQH extends com.ibm.mq.headers.internal.Header implements MQChainable
MQXQH (transmission queue header) header class. 
  struct tagMQXQH 
  {
                MQCHAR4   StrucId;         // Structure identifier
                MQLONG    Version;         // Structure version number
                MQCHAR48  RemoteQName;     // Name of destination queue
                MQCHAR48  RemoteQMgrName;  // Name of destination queue manager
                MQMD1     MsgDesc;         // Original message descriptor
  };

  • Nested Class Summary

    Nested classes/interfaces inherited from interface MQHeader

    MQHeader.Field

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    SIZE
    Size of an MQXQH structure in bytes

    Fields inherited from class com.ibm.mq.headers.internal.Header

    DEFAULT_CCSID, DEFAULT_ENCODING, delegate

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

    COMP_JM, COMP_JN, COMP_JO

  • Constructor Summary

    Constructors
    Constructor
    Description
    MQXQH()
    Constructs an MQXQH instance with default field values.
    MQXQH(DataInput message)
    Constructs an MQXQH instance populated from an MQMessage.
    MQXQH(DataInput message, int encoding, int characterSet)
    Constructs an MQXQH instance populated from a DataInput source.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    format()
     
    MQMD1
    getMsgDesc()
    get the message descriptor
    String
    getRemoteQMgrName()
    set the remote Queue Manager Name
    String
    getRemoteQName()
    get the remote Queue Name
    String
    getStrucId()
    Get the structure identifier; the value will be CMQC.MQXQH_STRUC_ID
    int
    getVersion()
    Get the Structure version number
    int
    nextCharacterSet()
     
    void
    nextCharacterSet(int value)
    Sets the CCSID of the next header or message content.
    int
    nextEncoding()
     
    void
    nextEncoding(int value)
    Sets the numeric encoding of the next header or message content.
    String
    nextFormat()
     
    void
    nextFormat(String value)
    Sets the format of the next header or message content.
    void
    setMsgDesc(MQMD1 value)
    set the message descriptor
    void
    setRemoteQMgrName(String value)
    get the remote Queue Manager Name
    void
    setRemoteQName(String value)
    set the remote Queue Name
    int
    size()
     

    Methods inherited from class com.ibm.mq.headers.internal.Header

    characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, store, store, toString, type, validate, write, write

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

    getJmqiEnvironment

    Methods inherited from class Object

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

  • Field Details

    • SIZE

      public static final int SIZE
      Size of an MQXQH structure in bytes
      See Also:

  • Constructor Details

    • MQXQH

      public MQXQH()
      Constructs an MQXQH instance with default field values.

    • MQXQH

      public MQXQH(DataInput message) throws MQDataException, IOException
      Constructs an MQXQH instance populated from an MQMessage.
      Parameters:
      message - the message to read
      Throws:
      MQDataException - if the message content does not yield a valid MQXQH stucture
      IOException - if there is a problem reading the message content

    • MQXQH

      public MQXQH(DataInput message, int encoding, int characterSet) throws MQDataException, IOException
      Constructs an MQXQH instance populated from a DataInput source.
      Parameters:
      message - the MQMessage or other DataInput source to read
      encoding - the initial numeric encoding of the data in the message
      characterSet - the initial CCSID of the data in the message
      Throws:
      MQDataException - if the message content does not yield a valid MQXQH stucture
      IOException - if there is a problem reading the message content

  • Method Details

    • getStrucId

      public String getStrucId()
      Get the structure identifier; the value will be CMQC.MQXQH_STRUC_ID
      Returns:
      the structure identifier

    • getVersion

      public int getVersion()
      Get the Structure version number
      Returns:
      the Structure version number

    • getRemoteQName

      public String getRemoteQName()
      get the remote Queue Name
      Returns:
      the remote Queue Name

    • setRemoteQName

      public void setRemoteQName(String value)
      set the remote Queue Name
      Parameters:
      value - the remote Queue Name

    • getRemoteQMgrName

      public String getRemoteQMgrName()
      set the remote Queue Manager Name
      Returns:
      the remote Queue Manager Name

    • setRemoteQMgrName

      public void setRemoteQMgrName(String value)
      get the remote Queue Manager Name
      Parameters:
      value - the remote Queue Manager Name

    • getMsgDesc

      public MQMD1 getMsgDesc()
      get the message descriptor
      Returns:
      the message descriptor

    • setMsgDesc

      public void setMsgDesc(MQMD1 value)
      set the message descriptor
      Parameters:
      value -

    • size

      public int size()
      Specified by:
      size in interface MQData
      Overrides:
      size in class com.ibm.mq.headers.internal.Header
      Returns:
      the size in bytes occupied by this data element in a message.
      See Also:
      • Header.size()

    • nextEncoding

      public int nextEncoding()
      Specified by:
      nextEncoding in interface MQChainable
      Returns:
      the numeric encoding of the next header or message content.
      See Also:

    • nextEncoding

      public void nextEncoding(int value)
      Description copied from interface: MQChainable
      Sets the numeric encoding of the next header or message content.
      Specified by:
      nextEncoding in interface MQChainable
      Parameters:
      value - numeric encoding
      See Also:

    • nextCharacterSet

      public int nextCharacterSet()
      Specified by:
      nextCharacterSet in interface MQChainable
      Returns:
      the CCSID of the next header or message content.
      See Also:

    • nextCharacterSet

      public void nextCharacterSet(int value)
      Description copied from interface: MQChainable
      Sets the CCSID of the next header or message content.
      Specified by:
      nextCharacterSet in interface MQChainable
      Parameters:
      value - character set
      See Also:

    • nextFormat

      public String nextFormat()
      Specified by:
      nextFormat in interface MQChainable
      Returns:
      the format of the next header or message content.
      See Also:

    • nextFormat

      public void nextFormat(String value)
      Description copied from interface: MQChainable
      Sets the format of the next header or message content.
      Specified by:
      nextFormat in interface MQChainable
      Parameters:
      value - format of the header or message content
      See Also:

    • format

      public String format()
      Specified by:
      format in interface MQChainable
      Returns:
      the format associated with this header object or message content.
      See Also: