Package 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
        };

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader

    MQHeader.Field

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

  • Method Summary

    Modifier and Type
    Method
    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
    String
    getFormat()
    gets the Format name of data that follows MQWIH
    byte[]
    getMsgToken()
    gets the message token
    String
    getServiceName()
    gets the service name
    String
    getServiceStep()
    gets the service step name
    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(String value)
    sets the Format name of data that follows MQWIH
    void
    setMsgToken(byte[] value)
    sets the message token
    void
    setServiceName(String value)
    sets the service name
    void
    setServiceStep(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 Details

    • MQWIH

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

    • MQWIH

      public MQWIH(DataInput message) throws MQDataException, 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
      IOException - if there is a problem reading the message content

    • MQWIH

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

  • Method Details

    • getStrucId

      public 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 String getFormat()
      gets the Format name of data that follows MQWIH
      Returns:
      the Format name of data that follows MQWIH

    • setFormat

      public void setFormat(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 String getServiceName()
      gets the service name
      Returns:
      the service name

    • setServiceName

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

    • getServiceStep

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

    • setServiceStep

      public void setServiceStep(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