Package com.ibm.mq.headers.pcf

Class MQCFGR

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.headers.pcf.PCFHeader
com.ibm.mq.headers.pcf.PCFParameter
com.ibm.mq.headers.pcf.MQCFGR
All Implemented Interfaces:
MQData, MQHeader, PCFContent
public class MQCFGR extends PCFParameter implements PCFContent
MQCFGR (PCF group parameter) header class. 
        struct tagMQCFGR {
          MQLONG  Type;            // Structure type
          MQLONG  StrucLength;     // Structure length
          MQLONG  Parameter;       // Parameter identifier
          MQLONG  ParameterCount;  // Count of group parameter structures
      };

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

  • Method Summary

    Modifier and Type
    Method
    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, 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, String value)
    Adds a string parameter to the group.
    void
    addParameter(int parameter, String[] values)
    Adds a string list parameter to the group.
    void
    addParameter(PCFParameter parameter)
    Adds a PCFParameter to the group.
    boolean
    equals(Object obj)
    Returns true when invoked with another MQCFGR instance with the same parameter, parameterCount, and parameter children.
    byte[]
    getBytesParameterValue(int parameter)
    Returns the value of the specified byte array parameter (MQCFBS).
    int
    getHeaderVersion()
    gets the version number of the header format
    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.
    int
    getParameter()
    gets the parameter identifier
    PCFParameter
    getParameter(int parameter)
    Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.
    int
    getParameterCount()
    gets the count of group parameter structures
    Enumeration
    getParameters()
    Returns an enumeration of the parameters in the group.
    Object
    getParameterValue(int parameter)
    Returns the value of the specified parameter, or null if the parameter is not found.
    String[]
    getStringListParameterValue(int parameter)
    Returns the value of the specified string list parameter (MQCFSL) as an array of strings.
    String
    getStringParameterValue(int parameter)
    Returns the value of the specified string parameter (MQCFST) as a string.
    int
    getStrucLength()
    Get the length of the structure.
    int
    getType()
    gets the structure type
    Object
    getValue()
    gets the parameter value
    int
    hashCode()
    Returns a hash code value for the object
    int
    read(DataInput message, int encoding, int characterSet)
    Reads content from a message or byte stream.
    void
    setParameter(int value)
    sets the parameter identifier
    int
    setParameterCount(int value)
    Sets the MQCFGR parameter count.
    String
    toString()
     
    int
    write(DataOutput messageP, int encoding, int characterSet)
    Writes the content of this data element to a message or byte stream.
    static int
    write(Object message, int parameter, int parameterCount)
    A convenience method for writing an MQCFGR header structure with the specified values to an MQMessage.

    Methods inherited from class com.ibm.mq.headers.pcf.PCFParameter

    getParameterName, getStringValue, nextParameter

    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, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MQCFGR

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

    • MQCFGR

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

    • MQCFGR

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

  • Method Details

    • write

      public static int write(Object message, int parameter, int parameterCount) throws IOException
      A convenience method for writing an MQCFGR header structure with the specified values to an MQMessage.
      Parameters:
      message - the message to write to
      parameter - the parameter identifier
      parameterCount - the number of parameter structures enclosed by the group
      Returns:
      the number of bytes written
      Throws:
      IOException - if there is a problem writing the message

    • read

      public int read(DataInput message, int encoding, int characterSet) throws MQDataException, IOException
      Description copied from interface: MQData
      Reads content from a message or byte stream. The content is interpreted (if applicable) using the specified encoding and CCSID.
      Specified by:
      read in interface MQData
      Overrides:
      read in class com.ibm.mq.headers.internal.Header
      Parameters:
      message - the message.
      encoding - the numeric encoding. see (CMQC.MQENC_* for values).
      characterSet - the Coded Character Set Identifier.
      Returns:
      the number of bytes consumed.
      Throws:
      MQDataException - if there is a problem reading the message content
      IOException - if an error occurs reading message content.
      See Also:
      • Header.read(java.io.DataInput, int, int)

    • write

      public int write(DataOutput messageP, int encoding, int characterSet) throws IOException
      Description copied from interface: MQData
      Writes the content of this data element to a message or byte stream. The content is encoded (if applicable) using the specified encoding and CCSID.
      Specified by:
      write in interface MQData
      Overrides:
      write in class com.ibm.mq.headers.internal.Header
      Parameters:
      messageP - the message.
      encoding - the numeric encoding. see (CMQC.MQENC_* for values)._
      characterSet - the Coded Character Set Identifier.
      Returns:
      the number of bytes written
      Throws:
      IOException - if an error occurs writing message content.
      See Also:

    • getType

      public int getType()
      gets the structure type
      Specified by:
      getType in class PCFHeader
      Returns:
      the structure type

    • getStrucLength

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

    • getParameter

      public int getParameter()
      gets the parameter identifier
      Specified by:
      getParameter in class PCFParameter
      Returns:
      the parameter identifier

    • setParameter

      public void setParameter(int value)
      sets the parameter identifier
      Parameters:
      value - the parameter identifier

    • getParameterCount

      public int getParameterCount()
      gets the count of group parameter structures
      Specified by:
      getParameterCount in interface PCFContent
      Returns:
      the count of group parameter structures

    • setParameterCount

      public int setParameterCount(int value)
      Sets the MQCFGR 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
      Returns:
      the new parameter Count

    • getValue

      public Object getValue()
      Description copied from class: PCFParameter
      gets the parameter value
      Specified by:
      getValue in class PCFParameter
      Returns:
      the parameter value
      See Also:

    • addParameter

      public void addParameter(PCFParameter parameter)
      Description copied from interface: PCFContent
      Adds a PCFParameter to the group.
      Specified by:
      addParameter in interface PCFContent
      Parameters:
      parameter - the parameter structure to add (MQCFIN, MQCFIL, MQCFST and so on)
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • addParameter

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

    • addParameter

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

    • 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:

    • 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:

    • addFilterParameter

      public void addFilterParameter(int parameter, int operator, String value)
      Description copied from interface: PCFContent
      Adds a 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:

    • 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:

    • getParameters

      public 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:
      an enumeration of parameters
      See Also:

    • getParameter

      public PCFParameter getParameter(int parameter)
      Description copied from interface: PCFContent
      Returns the PCFParameter structure for the specified parameter, or null if the parameter is not found.
      Specified by:
      getParameter in interface PCFContent
      Parameters:
      parameter - identifier whose details to be returned.
      Returns:
      the specified parameter object
      See Also:

    • getParameterValue

      public 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
      Parameters:
      parameter - identifier whose details to be returned
      Returns:
      the specified parameter value
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • getStringParameterValue

      public 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:

    • getStringListParameterValue

      public 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:

    • 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:

    • equals

      public boolean equals(Object obj)
      Returns true when invoked with another MQCFGR instance with the same parameter, parameterCount, and parameter children.
      Overrides:
      equals in class PCFParameter
      Parameters:
      obj - An object to compare with this instance
      Returns:
      true of the object equals this one

    • hashCode

      public int hashCode()
      Description copied from class: PCFParameter
      Returns a hash code value for the object
      Specified by:
      hashCode in class PCFParameter
      Returns:
      a hash code value for this object.
      See Also:

    • getHeaderVersion

      public int getHeaderVersion()
      Description copied from class: PCFParameter
      gets the version number of the header format
      Overrides:
      getHeaderVersion in class PCFParameter
      Returns:
      the version number of the header format
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class com.ibm.mq.headers.internal.Header
      See Also:
      • Header.toString()