com.ibm.mq.headers

Class MQWIH

  • java.lang.Object
    • com.ibm.mq.jmqi.JmqiObject
      • com.ibm.mq.headers.internal.Header
        • com.ibm.mq.headers.MQWIH
  • All Implemented Interfaces:
    MQData, MQHeader

    public class MQWIH
extends com.ibm.mq.headers.internal.Header
    MQWIH (work information header) header class. 
        struct tagMQWIH {
                MQCHAR4   StrucId;         // Structure identifier
                MQLONG    Version;         // Structure version number
                MQLONG    StrucLength;     // Length of MQWIH structure
                MQLONG    Encoding;        // Numeric encoding of data that follows MQWIH
                MQLONG    CodedCharSetId;  // Character-set identifier of data that follows MQWIH
                MQCHAR8   Format;          // Format name of data that follows MQWIH
                MQLONG    Flags;           // Flags
                MQCHAR32  ServiceName;     // Service name
                MQCHAR8   ServiceStep;     // Service step name
                MQBYTE16  MsgToken;        // Message token
                MQCHAR32  Reserved;        // Reserved
        };

    • Field Summary

      • 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 and Description
      MQWIH()
      Constructs an MQWIH instance with default field values.
      MQWIH(java.io.DataInput message)
      Constructs an MQWIH instance populated from an MQMessage.
      MQWIH(java.io.DataInput message, int encoding, int characterSet)
      Constructs an MQWIH instance populated from a DataInput source.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getCodedCharSetId()
      Get the Character set identifier of data that follows.
      int getEncoding()
      Get the numeric encoding of the data that follows.
      int getFlags()
      gets the Flags
      java.lang.String getFormat()
      gets the Format name of data that follows MQWIH
      byte[] getMsgToken()
      gets the message token
      java.lang.String getServiceName()
      gets the service name
      java.lang.String getServiceStep()
      gets the service step name
      java.lang.String getStrucId()
      Get the structure identifier; the value will be MQWIH_STRUC_ID
      int getStrucLength()
      Get the length of the structure.
      int getVersion()
      Get the Structure version number
      void setCodedCharSetId(int value)
      Set the Character set identifier of data that follows.
      void setEncoding(int value)
      Set the numeric encoding of the data that follows.
      void setFlags(int value)
      sets the Flags
      void setFormat(java.lang.String value)
      sets the Format name of data that follows MQWIH
      void setMsgToken(byte[] value)
      sets the message token
      void setServiceName(java.lang.String value)
      sets the service name
      void setServiceStep(java.lang.String value)
      sets the service step name

      • 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, size, store, store, toString, type, validate, write, write

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

        getJmqiEnvironment

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MQWIH

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

      • MQWIH

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

      • MQWIH

        public MQWIH(java.io.DataInput message,
             int encoding,
             int characterSet)
      throws MQDataException,
             java.io.IOException
        Constructs an MQWIH 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 MQWIH stucture
        java.io.IOException - if there is a problem reading the message content

    • Method Detail

      • getStrucId

        public java.lang.String getStrucId()
        Get the structure identifier; the value will be MQWIH_STRUC_ID
        Returns:
        the structure identifier

      • getVersion

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

      • getStrucLength

        public int getStrucLength()
        Get the length of the structure.
        Returns:
        the structure length.

      • getEncoding

        public int getEncoding()
        Get the numeric encoding of the data that follows.
        Returns:
        the numeric encoding. A combination of MQENC_* values.

      • setEncoding

        public void setEncoding(int value)
        Set the numeric encoding of the data that follows.
        Parameters:
        value - the numeric encoding. A combination of MQENC_* values.

      • getCodedCharSetId

        public int getCodedCharSetId()
        Get the Character set identifier of data that follows.
        Returns:
        the Character set identifier.

      • setCodedCharSetId

        public void setCodedCharSetId(int value)
        Set the Character set identifier of data that follows.
        Parameters:
        value - the Character set identifier.

      • getFormat

        public java.lang.String getFormat()
        gets the Format name of data that follows MQWIH
        Returns:
        the Format name of data that follows MQWIH

      • setFormat

        public void setFormat(java.lang.String value)
        sets the Format name of data that follows MQWIH
        Parameters:
        value - the Format name of data that follows MQWIH

      • getFlags

        public int getFlags()
        gets the Flags
        Returns:
        the Flags

      • setFlags

        public void setFlags(int value)
        sets the Flags
        Parameters:
        value - the Flags

      • getServiceName

        public java.lang.String getServiceName()
        gets the service name
        Returns:
        the service name

      • setServiceName

        public void setServiceName(java.lang.String value)
        sets the service name
        Parameters:
        value - the service name

      • getServiceStep

        public java.lang.String getServiceStep()
        gets the service step name
        Returns:
        the service step name

      • setServiceStep

        public void setServiceStep(java.lang.String value)
        sets the service step name
        Parameters:
        value - the service step name

      • getMsgToken

        public byte[] getMsgToken()
        gets the message token
        Returns:
        the message token

      • setMsgToken

        public void setMsgToken(byte[] value)
        sets the message token
        Parameters:
        value - the message token
Skip navigation links
(c) Copyright IBM Corp. 2008, 2016. All Rights Reserved.