com.ibm.mq.headers.pcf

类 PCFMessage

  • 所有已实现的接口：
    MQData， MQHeader和 PCFContent

    公用类 PCFMessage
扩展 PCFHeader
实现 PCFContent
    封装 PCF 消息的类。 PFMessage 通常表示 PCF 请求或响应或事件消息，该消息由 MQCFH 头后跟一组 PCFParameter 结构 (类型 MQCFIN ，MQC自行， 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)
      使用指定的 MQCFH 命令标识将 PCFMessage 初始化为 PCF 请求。
      PCFMessage(int type, int command, int msgSeqNumber, boolean last)
      使用指定的 MQCFH 类型，命令标识，序号和控制指示符来初始化 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)
      向 PCFMessage 添加 PCFParameter。
      boolean equals(java.lang.Object obj)
      当使用具有相同顺序的匹配头和等效参数的另一个 PCFMessage 实例调用时，返回 true。
      byte[] getBytesParameterValue(int parameter)
      返回指定字节数组参数 (MQCFBS) 的值。
      int getCommand()
      返回 PCF 命令标识
      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 结构，如果找不到该参数，那么返回 null。
      int getParameterCount()
      返回 PCF 消息中的参数结构数。
      java.util.Enumeration getParameters()
      返回组中参数的枚举。
      java.lang.Object getParameterValue(int parameter)
      返回指定参数的值，如果找不到参数，那么返回 null。
      int getReason()
      返回 MQCFH 中的原因码。
      java.lang.String[] getStringListParameterValue(int parameter)
      以字符串数组形式返回指定字符串列表参数 (MQCFSL) 的值。
      java.lang.String getStringParameterValue(int parameter)
      以字符串形式返回指定字符串参数 (MQCFST) 的值。
      int getType()
      返回 PCF 类型标识
      void initialize(int command)
      初始化 PCFMessage 以复用指定的命令标识而不使用任何参数。
      void initialize(int type, int command, int msgSeqNumber, boolean last)
      初始化 PCFMessage ，以便与指定的类型，命令标识，序号，控制指示符和无参数一起复用。
      void setHeader(MQCFH header)
      设置 PCFHeader 只能是 MQCFH ，因此不清楚先前方法存在的原因。
      void setHeader(PCFHeader header)
      设置 PCFHeader。设备中出现的模糊问题需要 Jackson 注释
      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)
      将此 PCFMessage 的内容写入到指定的编码和 CCSID 中，例如 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

      • 从类 com.ibm.mq.jmqi.JmqiObject 继承的方法

        getJmqiEnvironment

      • 从类 java.lang.Object 继承的方法

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

    • 构造函数详细信息

      • PCFMessage

        public PCFMessage (int 命令)
        使用指定的 MQCFH 命令标识将 PCFMessage 初始化为 PCF 请求。 随着参数的添加，参数计数将从零递增。
        参数：
        command -PCF 命令标识

      • PCFMessage

        public PCFMessage (int 类型，
                  int 命令，
                  int msgSeq数字，
                  布尔值最后一个)
        使用指定的 MQCFH 类型，命令标识，序号和控制指示符来初始化 PCFMessage。 随着参数的添加，参数计数将从零递增。 大多数应用程序将不需要使用此构造函数。 PCF 请求消息 (始终具有类型 MQCFT_COMMAND ，序号 1 和控制指示符设置为 MQCFC_LAST) 更易于使用 PCFMessage (int 命令) 表单来构造。
        参数：
        type -PCF 消息类型
        command -PCF 命令标识
        msgSeqNumber -消息的序号
        last -如果已设置，那么指示此消息是序列中的最后一条

      • PCFMessage

        public PCFMessage (java.io.DataInput 消息)
           抛出 MQDataException，
                  java.io.IOException
        从 MQMessage 的内容初始化 PCFMessage。
        参数：
        message -要从中读取的消息
        抛出：
        MQDataException -如果消息内容未生成有效的 PCFMessage
        java.io.IOException -如果读取消息时发生问题

    • 方法详细信息

      • 初始化

        public void initialize (int 命令)
        初始化 PCFMessage 以复用指定的命令标识而不使用任何参数。
        参数：
        command -PCF 命令标识

      • 初始化

        public void initialize (int type ，
                       int 命令，
                       int msgSeq数字，
                       布尔值最后一个)
        初始化 PCFMessage ，以便与指定的类型，命令标识，序号，控制指示符和无参数一起复用。 大多数应用程序将不需要使用此方法。 PCF 请求消息 (始终具有 MQCFT_COMMAND 类型，序号 1 和控制指示符设置为 MQCFC_LAST) 可以更轻松地使用 initialize (int 命令) 表单进行初始化。
        参数：
        type -PCF 消息类型
        command -PCF 命令标识
        msgSeqNumber -消息的序号
        last -如果已设置，那么指示此消息是序列中的最后一条

      • addParameter

        public void addParameter(PCFParameter 参数)
        向 PCFMessage 添加 PCFParameter。 如果需要，将自动更新 MQCFH 版本以与参数类型相对应。 (例如，如果添加了 PCF 过滤器参数，那么版本必须设置为 MQCFH_VERSION_3 。)
        指定者：
        addParameter在接口中PCFContent
        参数：
        parameter -要添加的参数结构 (MQCFIN ， MQCFIL ， MQCFST 等)
        另请参阅：
        PCFContent.addParameter(PCFParameter)

      • getType

        public int getType()
        返回 PCF 类型标识
        指定者：
        getType的实例PCFHeader
        返回：
        MQCFH 中类型 字段的值

      • getCommand

        public int getCommand()
        返回 PCF 命令标识
        返回：
        MQCFH 中命令 字段的值

      • getMsgSeqNumber

        public int getMsgSeqNumber()
        返回 PCF 消息序号
        返回：
        MQCFH 中 msgSeqNumber 字段的值

      • getControl

        public int getControl()
        返回 PCF 头控制指示符。
        返回：
        MQCFH 中控件 字段的值

      • getComp代码

        public int getComp代码 ()
        返回 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 头)
        设置 PCFHeader。设备中出现的模糊问题需要 Jackson 注释
        参数：
        header -要设置的值

      • setHeader

        public void setHeader(MQCFH 头)
        设置 PCFHeader 只能是 MQCFH ，因此不清楚先前方法存在的原因。 这是首选。 设备中提出的模糊问题需要 Jackson 注释
        参数：
        header -要设置的值

      • getParameter值

        public java.lang.Object getParameter值 (int 参数)
        从接口复制的描述: PCFContent
        返回指定参数的值，如果找不到参数，那么返回 null。 返回的对象是单个整数，单个字符串，整数数组或字符串数组，具体取决于 PCFParameter 的类型。 调用者可以从提供的参数标识推断期望的返回类型。
        指定者：
        getParameterValue在接口中PCFContent
        返回：
        指定的参数值
        另请参阅：
        PCFContent.getParameterValue(int)

      • getStringListParameter值

        public java.lang.String[] getStringListParameter值 (int 参数)
                                               抛出 PCFException
        从接口复制的描述: PCFContent
        以字符串数组形式返回指定字符串列表参数 (MQCFSL) 的值。
        指定者：
        getStringListParameterValue在接口中PCFContent
        参数：
        parameter -字符串列表参数标识
        返回：
        字符串列表参数值
        抛出：
        PCFException -如果组中不存在指定的参数 (给出的原因码为 MQRCCF_CFSL_PARM_ID_ERROR; 未定义更具体的错误代码)
        另请参阅：
        PCFContent.getStringListParameterValue(int)

      • 写

        public int write (java.io.DataOutput 消息)
          抛出 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 消息，
                 int         encoding,
                 int characterSet)
          抛出 java.io.IOException
        将此 PCFMessage 的内容写入到指定的编码和 CCSID 中，例如 MQMessage
        指定者：
        write在接口中MQData
        覆盖：
        write的实例com.ibm.mq.headers.internal.Header
        参数：
        message -要将字节写入的 DataOutput 对象
        encoding -要使用的数字编码方案
        characterSet -用于对字符数据进行编码的 CodedCharacterSetIdentifier
        返回：
        写入 DataOutput 对象的字节数
        抛出：
        java.io.IOException
        另请参阅：
        Header.write(DataOutput)

      • size

        公用整数大小 ()
        返回此 PCFMessage 的大小 (以字节计)。
        指定者：
        size在接口中MQData
        覆盖：
        size的实例com.ibm.mq.headers.internal.Header
        返回：
        消息中此数据元素占用的大小 (以字节计)。
        另请参阅：
        Header.size()

      • 等于

        public boolean 等于 (java.lang.Object obj)
        当使用具有相同顺序的匹配头和等效参数的另一个 PCFMessage 实例调用时，返回 true。
        覆盖：
        equals的实例java.lang.Object
        参数：
        obj -要比较的对象
        返回：
        对象的 true 等于此对象的 true

      • toString

        public java.lang.String toString()
        返回类实例的字符串表示
        覆盖：
        toString的实例com.ibm.mq.headers.internal.Header
        返回：
        字符串表示
跳过导航链接
© Copyright IBM Corp. 2008 ， 2016. All Rights Reserved.