com.ibm.mq.pcf

Class MQCFGR

  • All Implemented Interfaces:
    com.ibm.mq.headers.internal.CachingHeader, 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
        };

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      int parameter
      parameter identifier
      int parameterCount
      Count of group parameter structures
      int SIZE
      Deprecated. 
      prefer PCFHeader.size()
      static int strucLength
      structure length
      static int type
      structure type

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

        DEFAULT_CCSID, DEFAULT_ENCODING

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

        COMP_JM, COMP_JN, COMP_JO

    • Constructor Summary

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

    • Method Summary

      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.
      byte[] getBytesParameterValue(int parameter)
      Returns the value of the specified byte array parameter (MQCFBS).
      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
      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.
      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 getStringValue()
      Get the string value of the parameter
      int getStrucLength()
      Get the length of the structure.
      int getType()
      gets the structure type
      java.lang.Object getValue()
      Get the value of the parameter
      int hashCode()
      Returns a hash code value for the object
      int read(java.io.DataInput message, int encoding, int characterSet)
      Reads content from a message or byte stream.
      void setParameter(int value)
      sets the parameter identifier
      void setParameterCount(int value)
      Sets the MQCFGR parameter count.
      java.lang.String toString()
      return a string representing this header
      static int write(MQMessage 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.internal.Header

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.ibm.mq.headers.internal.CachingHeader

        discardCachedContent, readCachedContent, writeCachedContent

    • Field Detail

      • parameter

        public int parameter
        parameter identifier

      • parameterCount

        public int parameterCount
        Count of group parameter structures

    • Constructor Detail

      • MQCFGR

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

      • MQCFGR

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

      • MQCFGR

        public MQCFGR(java.io.DataInput message,
      int encoding,
      int characterSet)
       throws MQException,
              java.io.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:
        MQException - if the message content does not yield a valid MQCFGR stucture
        java.io.IOException - if there is a problem reading the message content

    • Method Detail

      • write

        public static int write(MQMessage message,
        int parameter,
        int parameterCount)
                 throws java.io.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:
        java.io.IOException - if there is a problem writing the message

      • read

        public int read(java.io.DataInput message,
       int encoding,
       int characterSet)
         throws MQException,
                java.io.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:
        java.io.IOException
        MQException
        See Also:
        Header.read(java.io.DataInput, int, int)

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

      • 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,
                java.lang.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:
        PCFContent.addParameter(int, String)

      • addParameter

        public void addParameter(int parameter,
                java.lang.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:
        PCFContent.addParameter(int, String[])

      • 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,
                      java.lang.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:
        PCFContent.addFilterParameter(int, int, String)

      • 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[])

      • 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:
        an enumeration of parameters
        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 PCFParameter
        Parameters:
        obj -
        Returns:
        true of the object equals this one

      • toString

        public java.lang.String toString()
        return a string representing this header
        Overrides:
        toString in class PCFHeader
        Returns:
        the string
        See Also:
        Object.toString()
(c) Copyright IBM Corp. 2008, 2015. All Rights Reserved.