com.ibm.mq.headers.pcf

類別 PCFMessage

  • 所有實作的介面:
    MQData, MQHeader, PCFContent

    public class PCFMessage
延伸 PCFHeader
實作 PCFContent
    封裝 PCF 訊息的類別。 PCFMessage 通常代表 PCF 要求或回應或事件訊息，其中包含 MQCFH 標頭，後面接著一組 PCFParameter 結構 (MQCFIN、MQCFIL、MQCFST 等類型)。 可以建構及操作 PCFMessage 實例，而無需直接參照 PCF 標頭及參數結構本身。
    另請參閱:
    PCFMessageAgent

    • 欄位摘要

      • 繼承自類別 com.ibm.mq.headers.internal.Header 的欄位

        DEFAULT_CCSID, DEFAULT_ENCODING, delegate

      • 繼承自類別 com.ibm.mq.jmqi.JmqiObject 的欄位

        COMP_JM, COMP_JN, COMP_JO

    • 建構子摘要

      建構子 
      建構子和說明
      PCFMessage(java.io.DataInput message)
      從 MQMessage 的內容起始設定 PCFMessage。
      PCFMessage(int command)
      將 PCFMessage 起始設定為具有指定 MQCFH 指令 ID 的 PCF 要求。
      PCFMessage(int type, int command, int msgSeqNumber, boolean last)
      以指定的 MQCFH 類型、指令 ID、序號及控制指示器來起始設定 PCFMessage。

    • 方法摘要

      所有方法 實例方法 具體方法 
      修飾元和類型 方法和說明
      void addFilterParameter(int parameter, int operator, byte[] value)
      將位元組字串過濾器參數新增至群組。
      void addFilterParameter(int parameter, int operator, int value)
      將整數過濾器參數新增至群組。
      void addFilterParameter(int parameter, int operator, java.lang.String value)
      將字串過濾器參數新增至群組。
      void addParameter(int parameter, byte[] value)
      將位元組陣列參數新增至群組。
      void addParameter(int parameter, int value)
      將整數參數新增至群組。
      void addParameter(int parameter, int[] values)
      將整數清單參數新增至群組。
      void addParameter(int parameter, long value)
      將 64 位元整數參數新增至群組。
      void addParameter(int parameter, long[] values)
      將 64 位元整數清單參數新增至群組。
      void addParameter(int parameter, java.lang.String value)
      將字串參數新增至群組。
      void addParameter(int parameter, java.lang.String[] values)
      將字串清單參數新增至群組。
      void addParameter(PCFParameter parameter)
      將 PCFParameter 新增至 PCFMessage。
      boolean equals(java.lang.Object obj)
      當使用另一個 PCFMessage 實例以相同順序呼叫時，會傳回 true ，該實例具有相符的標頭及相等參數。
      byte[] getBytesParameterValue(int parameter)
      傳回指定位元組陣列參數 (MQCFBS) 的值。
      int getCommand()
      傳回 PCF 指令 ID
      int getCompCode()
      傳回 MQCFH 中的完成碼。
      int getControl()
      傳回 PCF 標頭控制指示器。
      long getInt64ParameterValue(int parameter)
      以整數傳回指定整數參數 (MQCFIN64) 的值。
      long[] getIntList64ParameterValue(int parameter)
      以整數陣列形式傳回指定整數清單參數 (MQCFIL64) 的值。
      int[] getIntListParameterValue(int parameter)
      以整數陣列形式傳回指定整數清單參數 (MQCFIL) 的值。
      int getIntParameterValue(int parameter)
      以整數傳回指定整數參數 (MQCFIN) 的值。
      int getMsgSeqNumber()
      傳回 PCF 訊息序號
      PCFParameter getParameter(int parameter)
      傳回指定參數的 PCFParameter 結構，如果找不到參數，則傳回空值。
      int getParameterCount()
      傳回 PCF 訊息中的參數結構數目。
      java.util.Enumeration getParameters()
      傳回群組中參數的列舉。
      java.lang.Object getParameterValue(int parameter)
      傳回指定參數的值，如果找不到參數，則傳回空值。
      int getReason()
      傳回 MQCFH 中的原因碼。
      java.lang.String[] getStringListParameterValue(int parameter)
      以字串陣列形式傳回指定字串清單參數 (MQCFSL) 的值。
      java.lang.String getStringParameterValue(int parameter)
      以字串形式傳回指定字串參數 (MQCFST) 的值。
      int getType()
      傳回 PCF 類型 ID
      void initialize(int command)
      起始設定 PCFMessage ，以與指定的指令 ID (無參數) 一起重複使用。
      void initialize(int type, int command, int msgSeqNumber, boolean last)
      起始設定 PCFMessage ，以與指定的類型、指令 ID、序號、控制指示器及無參數一起重複使用。
      void setHeader(PCFHeader header)
      設定 PCFHeader
      int size()
      傳回此 PCFMessage 的大小 (以位元組為單位)。
      java.lang.String toString()
      傳回類別實例的字串表示法
      int write(java.io.DataOutput message)
      將此 PCFMessage 的內容寫入，例如 MQMessage。
      int write(java.io.DataOutput message, int encoding, int characterSet)
      以指定的編碼及 CCSID 將此 PCFMessage 的內容寫入 (例如 MQMessage)

      • 繼承自類別 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

      • 繼承自 java.lang.Object 類別的方法

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

    • 建構子詳細資料

      • PCFMessage

        public PCFMessage (int 指令)
        將 PCFMessage 起始設定為具有指定 MQCFH 指令 ID 的 PCF 要求。 當新增參數時，參數計數會從零遞增。
        參數：
        command-PCF 指令 ID

      • PCFMessage

        public PCFMessage (int type ，
                  int 指令，
                  int msgSeqNumber ，
                  布林 last)
        以指定的 MQCFH 類型、指令 ID、序號及控制指示器來起始設定 PCFMessage。 當新增參數時，參數計數會從零遞增。 大部分應用程式都不需要使用此建構子。 改為 PCF 要求訊息 (一律具有類型 MQCFT_COMMAND、序號 1 及設為 MQCFC_LAST 的控制指示器) 更容易使用 PCFMessage (int 指令) 來建構 表單。
        參數：
        type-PCF 訊息類型
        command-PCF 指令 ID
        msgSeqNumber-訊息的序號
        last-如果已設定，則指出此訊息是序列中的最後一則

      • PCFMessage

        public PCFMessage (java.io.DataInput message)
           throws MQDataException，
                  java.io.IOException
        從 MQMessage 的內容起始設定 PCFMessage。
        參數：
        message-要讀取的訊息
        擲出:
        MQDataException-如果訊息內容未產生有效的 PCFMessage
        java.io.IOException-如果在讀取訊息時發生問題

    • 方法詳細資料

      • 起始設定

        public void initialize (int command)
        起始設定 PCFMessage ，以與指定的指令 ID (無參數) 一起重複使用。
        參數：
        command-PCF 指令 ID

      • 起始設定

        public void initialize (int type ，
                       int 指令，
                       int msgSeqNumber ，
                       布林 last)
        起始設定 PCFMessage ，以與指定的類型、指令 ID、序號、控制指示器及無參數一起重複使用。 大部分應用程式將不需要使用此方法。 改為 PCF 要求訊息 (一律具有類型 MQCFT_COMMAND、序號 1 及控制指示器設為 MQCFC_LAST) 可以更輕鬆地使用 initialize (int 指令) 來起始設定 表單。
        參數：
        type-PCF 訊息類型
        command-PCF 指令 ID
        msgSeqNumber-訊息的序號
        last-如果已設定，則指出此訊息是序列中的最後一則

      • addParameter

        public void addParameter (PCFParameter parameter)
        將 PCFParameter 新增至 PCFMessage。 必要的話，會自動更新 MQCFH 版本，以對應參數類型。 (例如，如果新增 PCF 過濾器參數，則版本必須設為 MQCFH_VERSION_3 。)
        指定者:
        addParameter 在介面中 PCFContent
        參數：
        parameter-要新增的參數結構 (MQCFIN、MQCFIL、MQCFST 等)
        另請參閱:
        PCFContent.addParameter(PCFParameter)

      • addFilterParameter

        public void addFilterParameter (int parameter ，
                               int operator ，
                               byte [] value)
        從介面複製的說明: PCFContent
        將位元組字串過濾器參數新增至群組。
        指定者:
        addFilterParameter 在介面中 PCFContent
        參數：
        parameter-過濾器參數 ID
        operator-其中一個 MQCFOP_ * 過濾器運算子常數
        value-過濾器值
        另請參閱:
        PCFContent.addFilterParameter(int, int, byte[])

      • getType

        public int getType ()
        傳回 PCF 類型 ID
        指定者:
        getType 在類別中 PCFHeader
        傳回:
        來自 MQCFH 的 類型的值 欄位

      • getCommand

        public int getCommand ()
        傳回 PCF 指令 ID
        傳回:
        來自 MQCFH 的 指令的值 欄位

      • getMsgSeqNumber

        public int getMsgSeqNumber ()
        傳回 PCF 訊息序號
        傳回:
        來自 MQCFH 的 msgSeqNumber 的值 欄位

      • getControl

        public int getControl ()
        傳回 PCF 標頭控制指示器。
        傳回:
        來自 MQCFH 的 控制項的值 欄位

      • getCompCode

        public int getCompCode ()
        傳回 MQCFH 中的完成碼。
        傳回:
        來自 MQCFH 的 CompCode 的值 欄位

      • getReason

        public int getReason ()
        傳回 MQCFH 中的原因碼。
        傳回:
        來自 MQCFH 的 原因的值 欄位

      • getParameters

        public java.util.Enumeration getParameters ()
        從介面複製的說明: PCFContent
        傳回群組中參數的列舉。 傳回的列舉元素是個別 PCFParameter 實例 (MQCFIN、MQCFIL、MQCFST 或 MQCFSL 等實例)。
        指定者:
        getParameters 在介面中 PCFContent
        傳回:
        PCF 訊息參數結構
        另請參閱:
        PCFContent.getParameters()

      • setHeader

        public void setHeader (PCFHeader header)
        設定 PCFHeader
        參數：
        header-要設定的值

      • getParameterValue

        public java.lang.Object getParameterValue (int parameter)
        從介面複製的說明: PCFContent
        傳回指定參數的值，如果找不到參數，則傳回空值。 傳回的物件是單一整數、單一字串、整數陣列或字串陣列，視 PCFParameter 的類型而定。 呼叫者可以從提供的參數 ID 推斷預期的傳回類型。
        指定者:
        getParameterValue 在介面中 PCFContent
        傳回:
        指定的參數值
        另請參閱:
        PCFContent.getParameterValue(int)

      • getStringListParameterValue

        public java.lang.String [] getStringListParameterValue (int parameter)
                                               throws PCFException
        從介面複製的說明: PCFContent
        以字串陣列形式傳回指定字串清單參數 (MQCFSL) 的值。
        指定者:
        getStringListParameterValue 在介面中 PCFContent
        參數：
        parameter-字串清單參數 ID
        傳回:
        字串清單參數值
        擲出:
        PCFException-如果指定的參數不存在於群組中 (給定的原因碼為 MQRCCF_CFSL_PARM_ID_ERROR; 未定義其他特定的錯誤碼)
        另請參閱:
        PCFContent.getStringListParameterValue(int)

      • 寫入

        public int write (java.io.DataOutput message)
          throws java.io.IOException
        將此 PCFMessage 的內容寫入，例如 MQMessage。
        指定者:
        write 在介面中 MQData
        置換:
        write 在類別中 com.ibm.mq.headers.internal.Header
        參數：
        message-訊息
        傳回:
        寫入的位元組數
        擲出:
        java.io.IOException
        另請參閱:
        Header.write(DataOutput)

      • 寫入

        public int write (java.io.DataOutput message ，
                 int encoding ，
                 int characterSet)
          throws java.io.IOException
        以指定的編碼及 CCSID 將此 PCFMessage 的內容寫入 (例如 MQMessage)
        指定者:
        write 在介面中 MQData
        置換:
        write 在類別中 com.ibm.mq.headers.internal.Header
        參數：
        message-要寫入位元組的 DataOutput 物件
        encoding-要使用的數值編碼方法
        characterSet-編碼字元資料的 CodedCharacterSetIdentifier
        傳回:
        寫入 DataOutput 物件的位元組數
        擲出:
        java.io.IOException
        另請參閱:
        Header.write(DataOutput)

      • 大小

        public int size ()
        傳回此 PCFMessage 的大小 (以位元組為單位)。
        指定者:
        size 在介面中 MQData
        置換:
        size 在類別中 com.ibm.mq.headers.internal.Header
        傳回:
        此資料元素在訊息中所佔用的大小 (以位元組為單位)。
        另請參閱:
        Header.size()

      • 等於

        public boolean equals (java.lang.Object obj)
        當使用另一個 PCFMessage 實例以相同順序呼叫時，會傳回 true ，該實例具有相符的標頭及相等參數。
        置換:
        equals 在類別中 java.lang.Object
        參數：
        obj-要比較的物件
        傳回:
        true of the object equals this one

      • toString

        public java.lang.String toString ()
        傳回類別實例的字串表示法
        置換:
        toString 在類別中 com.ibm.mq.headers.internal.Header
        傳回:
        字串表示法
跳過導覽鏈結
© Copyright IBM Corp. 2008 ， 2016. All Rights Reserved.