com.ibm.mq.headers.pcf

Class MQEPH

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

    public class MQEPH
extends com.ibm.mq.headers.internal.Header
implements MQChainable, PCFContent
    MQEPH (Embedded PCF) header class. 
     struct tagMQEPH {
   MQCHAR4 StrucId;       // Structure identifier
   MQLONG  Version;        // Structure version number
   MQLONG  StrucLength;    // Total length of MQEPH including MQCFHameter structures that follow
   MQLONG  Encoding;       // Numeric encoding of data that follows last PCF parameter structure
   MQLONG  CodedCharSetId; // Character set identifier of data that follows last PCF parameter structure
   MQCHAR8 Format;         // Format name of data that follows last PCF parameter structure
   MQLONG  Flags;          // Flags
   MQCFH   PCFHeader;      // Programmable Command Format Header
 }

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int SIZE
      size of an MQEPH header 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 and Description
      MQEPH()
      Constructs an MQEPH instance with default field values.
      MQEPH(java.io.DataInput message)
      Constructs an MQEPH instance populated from an DataInput.
      MQEPH(java.io.DataInput message, int encoding, int characterSet)
      Constructs an MQEPH instance populated from a DataInput source.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addFilterParameter(int parameter, int operator, byte[] value)
      Adds a bytes string filter parameter to the group.
      void addFilterParameter(int parameter, int operator, int value)
      Adds an integer filter parameter to the group.
      void addFilterParameter(int parameter, int operator, java.lang.String value)
      Adds a string filter parameter to the group.
      void addParameter(int parameter, byte[] value)
      Adds a byte array parameter to the group.
      void addParameter(int parameter, int value)
      Adds an integer parameter to the group.
      void addParameter(int parameter, int[] values)
      Adds an integer list parameter to the group.
      void addParameter(int parameter, long value)
      Adds a 64-bit integer parameter to the group.
      void addParameter(int parameter, long[] values)
      Adds a 64-bit integer list parameter to the group.
      void addParameter(int parameter, java.lang.String value)
      Adds a string parameter to the group.
      void addParameter(int parameter, java.lang.String[] values)
      Adds a string list parameter to the group.
      void addParameter(PCFParameter parameter)
      Adds a PCFParameter to the group.
      boolean equals(java.lang.Object obj)
      Returns true when invoked with another MQCFGR instance with the same parameter, parameterCount, and parameter children.
      java.lang.String format() 
      byte[] getBytesParameterValue(int parameter)
      Returns the value of the specified byte array parameter (MQCFBS).
      int getCodedCharSetId()
      Get the Character set identifier of data that follows.
      int getEncoding()
      Get the numeric encoding of the data that follows.
      int getFlags()
      get the Flags
      java.lang.String getFormat()
      get the Format name of data that follows last PCF parameter structure
      long getInt64ParameterValue(int parameter)
      Returns the value of the specified integer parameter (MQCFIN64) as an integer.
      long[] getIntList64ParameterValue(int parameter)
      Returns the value of the specified integer list parameter (MQCFIL64) as an array of integers.
      int[] getIntListParameterValue(int parameter)
      Returns the value of the specified integer list parameter (MQCFIL) as an array of integers.
      int getIntParameterValue(int parameter)
      Returns the value of the specified integer parameter (MQCFIN) as an integer.
      PCFParameter getParameter(int parameter)
      Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.
      int getParameterCount()
      Returns the number of parameter structures in the group.
      java.util.Enumeration getParameters()
      Returns an enumeration of the parameters in the group.
      java.lang.Object getParameterValue(int parameter)
      Returns the value of the specified parameter, or null if the parameter is not found.
      MQCFH getPCFHeader()
      get the PCF header
      java.lang.String[] getStringListParameterValue(int parameter)
      Returns the value of the specified string list parameter (MQCFSL) as an array of strings.
      java.lang.String getStringParameterValue(int parameter)
      Returns the value of the specified string parameter (MQCFST) as a string.
      java.lang.String getStrucId()
      Get the structure identifier; the value will be MQEPH_STRUC_ID
      int getVersion()
      Get the Structure version number
      int nextCharacterSet()
      get the CCSID of the next message
      void nextCharacterSet(int value)
      set the CCSID of the next message
      int nextEncoding()
      get the encoding of the next message
      void nextEncoding(int value)
      set the encoding of the next message
      java.lang.String nextFormat()
      get the format of the next message
      void nextFormat(java.lang.String value)
      set the format of the next message
      int read(java.io.DataInput message, int encoding, int characterSet)
      Populates this MQEPH object with data from the specified message
      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)
      set the Flags
      void setFormat(java.lang.String value)
      set the Format name of data that follows last PCF parameter structure
      void setParameterCount(int value)
      Sets the MQEPH parameter count.
      void setPCFHeader(MQCFH value)
      set the PCF header
      java.lang.String toString()
      return a string representation of this header
      int write(java.io.DataOutput message, int encoding, int characterSet)
      writes this header to the specified message

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

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

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

        getJmqiEnvironment

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MQEPH

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

      • MQEPH

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

      • MQEPH

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

    • Method Detail

      • read

        public int read(java.io.DataInput message,
                int encoding,
                int characterSet)
         throws MQDataException,
                java.io.IOException
        Populates this MQEPH object with data from the specified message
        Specified by:
        read in interface MQData
        Overrides:
        read in class com.ibm.mq.headers.internal.Header
        Parameters:
        message - the message
        encoding - the encoding (big/little-endian)
        characterSet - the CCSID
        Returns:
        the number of bytes read
        Throws:
        MQDataException
        java.io.IOException

      • write

        public int write(java.io.DataOutput message,
                 int encoding,
                 int characterSet)
          throws java.io.IOException
        writes this header to the specified message
        Specified by:
        write in interface MQData
        Overrides:
        write in class com.ibm.mq.headers.internal.Header
        Parameters:
        message - the message
        encoding - the encoding (big/little-endian)
        characterSet - the CCSID
        Returns:
        the number of bytes written
        Throws:
        java.io.IOException

      • getStrucId

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

      • getVersion

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

      • 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()
        get the Format name of data that follows last PCF parameter structure
        Returns:
        the Format name of data that follows last PCF parameter structure

      • setFormat

        public void setFormat(java.lang.String value)
        set the Format name of data that follows last PCF parameter structure
        Parameters:
        value - the Format name of data that follows last PCF parameter structure

      • getFlags

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

      • setFlags

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

      • getPCFHeader

        public MQCFH getPCFHeader()
        get the PCF header
        Returns:
        the header

      • setPCFHeader

        public void setPCFHeader(MQCFH value)
        set the PCF header
        Parameters:
        value - the header

      • nextEncoding

        public int nextEncoding()
        get the encoding of the next message
        Specified by:
        nextEncoding in interface MQChainable
        Returns:
        the encoding

      • nextEncoding

        public void nextEncoding(int value)
        set the encoding of the next message
        Specified by:
        nextEncoding in interface MQChainable
        Parameters:
        value - the encoding

      • nextCharacterSet

        public int nextCharacterSet()
        get the CCSID of the next message
        Specified by:
        nextCharacterSet in interface MQChainable
        Returns:
        the CCSID

      • nextCharacterSet

        public void nextCharacterSet(int value)
        set the CCSID of the next message
        Specified by:
        nextCharacterSet in interface MQChainable
        Parameters:
        value - the CCSID

      • nextFormat

        public java.lang.String nextFormat()
        get the format of the next message
        Specified by:
        nextFormat in interface MQChainable
        Returns:
        the format

      • nextFormat

        public void nextFormat(java.lang.String value)
        set the format of the next message
        Specified by:
        nextFormat in interface MQChainable
        Parameters:
        value - the format

      • format

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

      • addParameter

        public void addParameter(int parameter,
                         int value)
        Description copied from interface: PCFContent
        Adds an integer parameter to the group.
        Specified by:
        addParameter in interface PCFContent
        Parameters:
        parameter - the integer parameter identifier
        value - the integer value
        See Also:
        PCFContent.addParameter(int, int)

      • addParameter

        public void addParameter(int parameter,
                         int[] values)
        Description copied from interface: PCFContent
        Adds an integer list parameter to the group.
        Specified by:
        addParameter in interface PCFContent
        Parameters:
        parameter - the integer list parameter identifier
        values - the array of integer values
        See Also:
        PCFContent.addParameter(int, int[])

      • addParameter

        public void addParameter(int parameter,
                         long value)
        Description copied from interface: PCFContent
        Adds a 64-bit integer parameter to the group.
        Specified by:
        addParameter in interface PCFContent
        Parameters:
        parameter - the integer parameter identifier
        value - the integer value
        See Also:
        PCFContent.addParameter(int, long)

      • addParameter

        public void addParameter(int parameter,
                         long[] values)
        Description copied from interface: PCFContent
        Adds a 64-bit integer list parameter to the group.
        Specified by:
        addParameter in interface PCFContent
        Parameters:
        parameter - the integer list parameter identifier
        values - the array of integer values
        See Also:
        PCFContent.addParameter(int, long[])

      • addParameter

        public void addParameter(int parameter,
                         byte[] value)
        Description copied from interface: PCFContent
        Adds a byte array parameter to the group.
        Specified by:
        addParameter in interface PCFContent
        Parameters:
        parameter - the string list parameter identifier
        value - the array of string values
        See Also:
        PCFContent.addParameter(int, byte[])

      • addFilterParameter

        public void addFilterParameter(int parameter,
                               int operator,
                               int value)
        Description copied from interface: PCFContent
        Adds an integer filter parameter to the group.
        Specified by:
        addFilterParameter in interface PCFContent
        Parameters:
        parameter - the filter parameter identifier
        operator - one of the MQCFOP_* filter operator constants
        value - the filter value
        See Also:
        PCFContent.addFilterParameter(int, int, int)

      • addFilterParameter

        public void addFilterParameter(int parameter,
                               int operator,
                               byte[] value)
        Description copied from interface: PCFContent
        Adds a bytes string filter parameter to the group.
        Specified by:
        addFilterParameter in interface PCFContent
        Parameters:
        parameter - the filter parameter identifier
        operator - one of the MQCFOP_* filter operator constants
        value - the filter value
        See Also:
        PCFContent.addFilterParameter(int, int, byte[])

      • setParameterCount

        public void setParameterCount(int value)
        Sets the MQEPH parameter count. This has the effect of trimming the size of the child PCFParameter collection to the number specified. If the argument is zero, the effect is to clear all child parameters. Specifying a value larger than the current parameter count has no effect. Negative values are ignored.
        Parameters:
        value - the integer value as an Integer object

      • getParameters

        public java.util.Enumeration getParameters()
        Description copied from interface: PCFContent
        Returns an enumeration of the parameters in the group. The elements of the Enumeration returned are individual PCFParameter instances (instances of MQCFIN, MQCFIL, MQCFST or MQCFSL etc.).
        Specified by:
        getParameters in interface PCFContent
        Returns:
        the PCF message parameter structures
        See Also:
        PCFContent.getParameters()

      • getParameterValue

        public java.lang.Object getParameterValue(int parameter)
        Description copied from interface: PCFContent
        Returns the value of the specified parameter, or null if the parameter is not found. The object returned is a single Integer, a single String, an array of integers or array of Strings depending on the type of PCFParameter. The caller can infer the expected return type from the supplied parameter identifier.
        Specified by:
        getParameterValue in interface PCFContent
        Returns:
        the specified parameter value
        See Also:
        PCFContent.getParameterValue(int)

      • getIntParameterValue

        public int getIntParameterValue(int parameter)
                         throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified integer parameter (MQCFIN) as an integer.
        Specified by:
        getIntParameterValue in interface PCFContent
        Parameters:
        parameter - the integer parameter identifier
        Returns:
        the integer parameter value
        Throws:
        PCFException - if the specified parameter does not exist in the message (the reason code given is MQRCCF_CFIN_PARM_ID_ERROR)
        See Also:
        PCFContent.getIntParameterValue(int)

      • getIntListParameterValue

        public int[] getIntListParameterValue(int parameter)
                               throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified integer list parameter (MQCFIL) as an array of integers.
        Specified by:
        getIntListParameterValue in interface PCFContent
        Parameters:
        parameter - the integer list parameter identifier
        Returns:
        the integer list parameter values
        Throws:
        PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFIL_PARM_ID_ERROR)
        See Also:
        PCFContent.getIntListParameterValue(int)

      • getInt64ParameterValue

        public long getInt64ParameterValue(int parameter)
                            throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified integer parameter (MQCFIN64) as an integer.
        Specified by:
        getInt64ParameterValue in interface PCFContent
        Parameters:
        parameter - the integer parameter identifier
        Returns:
        the integer parameter value
        Throws:
        PCFException - if the specified parameter does not exist in the message (the reason code given is MQRCCF_CFIN_PARM_ID_ERROR)
        See Also:
        PCFContent.getInt64ParameterValue(int)

      • getIntList64ParameterValue

        public long[] getIntList64ParameterValue(int parameter)
                                  throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified integer list parameter (MQCFIL64) as an array of integers.
        Specified by:
        getIntList64ParameterValue in interface PCFContent
        Parameters:
        parameter - the integer list parameter identifier
        Returns:
        the integer list parameter values
        Throws:
        PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFIL_PARM_ID_ERROR)
        See Also:
        PCFContent.getIntList64ParameterValue(int)

      • getStringParameterValue

        public java.lang.String getStringParameterValue(int parameter)
                                         throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified string parameter (MQCFST) as a string.
        Specified by:
        getStringParameterValue in interface PCFContent
        Parameters:
        parameter - the string parameter identifier
        Returns:
        the string parameter value
        Throws:
        PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFST_PARM_ID_ERROR)
        See Also:
        PCFContent.getStringParameterValue(int)

      • getStringListParameterValue

        public java.lang.String[] getStringListParameterValue(int parameter)
                                               throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified string list parameter (MQCFSL) as an array of strings.
        Specified by:
        getStringListParameterValue in interface PCFContent
        Parameters:
        parameter - the string list parameter identifier
        Returns:
        the string list parameter values
        Throws:
        PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFSL_PARM_ID_ERROR; no more specific error code is defined)
        See Also:
        PCFContent.getStringListParameterValue(int)

      • getBytesParameterValue

        public byte[] getBytesParameterValue(int parameter)
                              throws PCFException
        Description copied from interface: PCFContent
        Returns the value of the specified byte array parameter (MQCFBS).
        Specified by:
        getBytesParameterValue in interface PCFContent
        Parameters:
        parameter - the byte array parameter identifier
        Returns:
        the byte array parameter value
        Throws:
        PCFException - if the specified parameter does not exist in the group (the reason code given is MQRCCF_CFBS_PARM_ID_ERROR)
        See Also:
        PCFContent.getBytesParameterValue(int)

      • equals

        public boolean equals(java.lang.Object obj)
        Returns true when invoked with another MQCFGR instance with the same parameter, parameterCount, and parameter children.
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        return a string representation of this header
        Overrides:
        toString in class com.ibm.mq.headers.internal.Header
Skip navigation links
(c) Copyright IBM Corp. 2008, 2016. All Rights Reserved.