com.ibm.mq.headers.pcf

Class PCFMessage

  • All Implemented Interfaces:
    MQData, MQHeader, PCFContent

    public class PCFMessage
extends PCFHeader
implements PCFContent
    Class encapsulating a PCF message. A PCFMessage typically represents a PCF request or response or an event message, which consists of an MQCFH header followed by a set of PCFParameter structures (type MQCFIN, MQCFIL, MQCFST and so on). A PCFMessage instance can be constructed and manipulated without direct reference to the PCF header and parameter structures themselves.
    See Also:
    PCFMessageAgent

    • Field Summary

      • 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
      PCFMessage(java.io.DataInput message)
      Initializes a PCFMessage from the contents of an MQMessage.
      PCFMessage(int command)
      Initializes a PCFMessage as a PCF request with the specified MQCFH command identifier.
      PCFMessage(int type, int command, int msgSeqNumber, boolean last)
      Initializes a PCFMessage with the specified MQCFH type, command identifier, sequence number and control indicator.

    • 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 PCFMessage.
      boolean equals(java.lang.Object obj)
      Returns true when invoked with another PCFMessage instance with matching header and equivalent parameters in the same order.
      byte[] getBytesParameterValue(int parameter)
      Returns the value of the specified byte array parameter (MQCFBS).
      int getCommand()
      Returns the PCF command identifier
      int getCompCode()
      Returns the completion code in the MQCFH.
      int getControl()
      Returns the PCF header control indicator.
      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 getMsgSeqNumber()
      Returns the PCF message sequence number
      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 PCF message.
      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.
      int getReason()
      Returns the reason code in the MQCFH.
      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.
      int getType()
      Returns the PCF type identifier
      void initialize(int command)
      Initializes a PCFMessage for re-use with the specified command identifier and no parameters.
      void initialize(int type, int command, int msgSeqNumber, boolean last)
      Initializes a PCFMessage for re-use with the specified type, command identifier, sequence number, control indicator and no parameters.
      void setHeader(PCFHeader header)
      Set the PCFHeader
      int size()
      Returns the size of this PCFMessage in bytes.
      java.lang.String toString()
      Returns the string representation of the class instance
      int write(java.io.DataOutput message)
      Writes the content of this PCFMessage to, e.g., 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, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, store, store, type, validate, write

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PCFMessage

        public PCFMessage(int command)
        Initializes a PCFMessage as a PCF request with the specified MQCFH command identifier. The parameter count is incremented from zero as parameters are added.
        Parameters:
        command - the PCF command identifier

      • PCFMessage

        public PCFMessage(int type,
          int command,
          int msgSeqNumber,
          boolean last)
        Initializes a PCFMessage with the specified MQCFH type, command identifier, sequence number and control indicator. The parameter count is incremented from zero as parameters are added. Most applications will not need to use this constructor. PCF request messages, which always have type MQCFT_COMMAND, sequence number 1 and control indicator set to MQCFC_LAST, are more easily constructed using the PCFMessage(int command) form instead.
        Parameters:
        type - the PCF message type
        command - the PCF command identifier
        msgSeqNumber - the sequence number of the message
        last - if set, indicates this message is the last in a sequence

      • PCFMessage

        public PCFMessage(java.io.DataInput message)
           throws MQDataException,
                  java.io.IOException
        Initializes a PCFMessage from the contents of an MQMessage.
        Parameters:
        message - the message to read from
        Throws:
        MQDataException - if the message contents do not yield a valid PCFMessage
        java.io.IOException - if there is a problem reading the message

    • Method Detail

      • initialize

        public void initialize(int command)
        Initializes a PCFMessage for re-use with the specified command identifier and no parameters.
        Parameters:
        command - the PCF command identifier

      • initialize

        public void initialize(int type,
              int command,
              int msgSeqNumber,
              boolean last)
        Initializes a PCFMessage for re-use with the specified type, command identifier, sequence number, control indicator and no parameters. Most applications will not need to use this method. PCF request messages, which always have type MQCFT_COMMAND, sequence number 1 and control indicator set to MQCFC_LAST, can more easily be initialized using the initialize(int command) form instead.
        Parameters:
        type - the PCF message type
        command - the PCF command identifier
        msgSeqNumber - the sequence number of the message
        last - if set, indicates this message is the last in a sequence

      • addParameter

        public void addParameter(PCFParameter parameter)
        Adds a PCFParameter to the PCFMessage. The MQCFH version is updated automatically if necessary to correspond with the parameter type. (For example, the version must be set to MQCFH_VERSION_3 if a PCF filter parameter is added.)
        Specified by:
        addParameter in interface PCFContent
        Parameters:
        parameter - the parameter structure to add (MQCFIN, MQCFIL, MQCFST and so on)
        See Also:
        PCFContent.addParameter(PCFParameter)

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

      • getType

        public int getType()
        Returns the PCF type identifier
        Specified by:
        getType in class PCFHeader
        Returns:
        the value of the type field from the MQCFH

      • getCommand

        public int getCommand()
        Returns the PCF command identifier
        Returns:
        the value of the command field from the MQCFH

      • getMsgSeqNumber

        public int getMsgSeqNumber()
        Returns the PCF message sequence number
        Returns:
        the value of the msgSeqNumber field from the MQCFH

      • getControl

        public int getControl()
        Returns the PCF header control indicator.
        Returns:
        the value of the control field from the MQCFH

      • getCompCode

        public int getCompCode()
        Returns the completion code in the MQCFH.
        Returns:
        the value of the compCode field from the MQCFH

      • getReason

        public int getReason()
        Returns the reason code in the MQCFH.
        Returns:
        the value of the reason field from the MQCFH

      • 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()

      • setHeader

        public void setHeader(PCFHeader header)
        Set the PCFHeader
        Parameters:
        header - The value to set

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

      • write

        public int write(java.io.DataOutput message)
          throws java.io.IOException
        Writes the content of this PCFMessage to, e.g., an MQMessage.
        Specified by:
        write in interface MQData
        Overrides:
        write in class com.ibm.mq.headers.internal.Header
        Parameters:
        message - the message.
        Returns:
        the number of bytes written
        Throws:
        java.io.IOException
        See Also:
        Header.write(DataOutput)

      • size

        public int size()
        Returns the size of this PCFMessage in bytes.
        Specified by:
        size in interface MQData
        Overrides:
        size in class com.ibm.mq.headers.internal.Header
        Returns:
        the size in bytes occupied by this data element in a message.
        See Also:
        Header.size()

      • equals

        public boolean equals(java.lang.Object obj)
        Returns true when invoked with another PCFMessage instance with matching header and equivalent parameters in the same order.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - The object to compare against
        Returns:
        true of the object equals this one

      • toString

        public java.lang.String toString()
        Returns the string representation of the class instance
        Overrides:
        toString in class com.ibm.mq.headers.internal.Header
        Returns:
        The string representation
(c) Copyright IBM Corp. 2008, 2015. All Rights Reserved.