ICS 35.240 GA 06V 中华人民共和国公共安全行业标准 GA/T1038.3—2012 消防公共服务平台技术规范 第3部分：信息交换接口 Technical specifications for the public fire service platform- Part 3:Information exchange interfaces 2012-12-27发布 2013-01-01实施 中华人民共和国公安部 发布 GA/T1038.3—2012 前 言 GA/T1038《消防公共服务平台技术规范》拟分部分出版，各部分将按照在消防公共服务平台的作 用确立。下面列出本标准的预计部分： 一第1部分：总体架构及功能要求； 一第2部分：服务管理接口； 一第3部分：信息交换接口； 一第4部分：消防综合业务接口； 一第5部分：地理信息服务接口。 本部分为GA/T1038的第3部分。 本部分按照GB/T1.1一2009给出的规则起草。 本部分由公安部消防局提出。 本部分由公安部计算机与信息处理标准化技术委员会归口。 本部分起草单位：公安部沈阳消防研究所。 本部分主要起草人：姜学赞、朱春玲、张春华、王佩青、梁云杰、吕建波、周蓉蓉、林晓冬。 I GA/T 1038.3—2012 消防公共服务平台技术规范 第3部分：信息交换接口 1范围 GA/T1038的本部分规定了消防公共服务平台中信息交换平台（以下简称平台）对消息收发方提 供的软件接口（以下简称接口)功能及参数。 本部分适用于信息交换平台，以及需使用信息交换平台进行消息发送、接收和订阅的应用实体的开 发和应用。 2规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文 件。凡是不注日期的引用文件，其最新版本（包括所有的修改单)适用于本文件。 GA/T1038.1一2012消防公共服务平台技术规范第1部分：总体架构及功能要求 3术语、定义和缩略语 GA/T1038.1一2012界定的术语、定义和缩略语适用于本文件。 4平台接口 4.1接口功能 平台提供收发消息接口、设置并开启消息监听接口、关闭消息监听接口、应用组信息接口、本平台信 息接口和主题发布订阅信息接口等六类接口，功能如下： a) 收发消息接口：用于发送消息和单次接收消息； b）设置并开启消息监听接口：开启对消息队列的监听，用于设置并启动监听方式持续接收发送 来的消息，直至调用关闭消息监听接口消息接收才停止； c) 关闭消息监听接口：关闭对消息队列的监听，停止用监听方式接收消息； (P 应用组信息接口：创建和查询应用组信息； e) 平台信息接口：查看平台消息服务器信息； f) 主题发布订阅信息接口：获得主题发布订阅的记录。 4.2接口参数 4.2.1类名称和说明 平台接口使用的自定义类名称和说明见表1。 1 GA/T1038.3—2012 表1类名称和说明 序号 类名称 说 明 1 message 发送消息类，具体要求见4.2.2 2 MOMResponse 返回值类，具体要求见4.2.3 3 thisPlatFormBean 平台信息类，具体要求见4.2.4 4 abstractMessageListener 消息队列监听器，具体要求见4.2.5 5 list 一类参数的列表 4. 2. 2 发送消息类 发送消息类定义了发送消息的结构，内容见表2。 表2 发送消息类的内容 序号 名称 标识 注 兄明 发送方 发送方应用账号 1 from string 的应用账 2 接收方 to 个应用时用 3 消息标 识 msgSt string 消息的唯一 4 消息体 消息的实际内容 messageB ing 0为文术消息， 2为回执消息发 送时无锦设置或设 5 消息类型 string messageType 置为0，收到消息需 要判断消息类型是 否为2 取值范围： FOREVER一永远有效 消息的有效期，过 WEEK- 一一周有效 6 时效性 expiration char 期消息将无法到达 DAY一一天有效 目的地 HOUR- 一小时有效 MINUTE- 分钟有效 取值范围： 发送方可根据消 MIN一最低优先级 7 优先级 priority char 息的级别来定义优 NORM一中级优先级 先级 MAX一最高优先级 isReceipt boolean 8 是否要求回执 要求：true，不要求：false 用于回执跟踪的 标识需唯一，具体规则由各 回执ID 9 receiptID string 标识 业务系统自己定义 2 GA/T1038.3—2012 4.2.3返回值类 调用收发消息接口进行收发消息，返回此返回值类，内容见表3。使用收发消息接口发送消息和使 用监听方式接收消息时，只返回returnCode；使用收发消息接口接收消息时，返回returnCode和re- ceiveMessage。returnCode为调用结果代码，用于返回调用结果，采用调用结果消息代码，具体见4.4。 表3返回值类的内容 序号 名称 标识 类型 说明 备注 返回调用结果，采用调用结果 调用结果消息 调用结果代码 returnCode string 消息代码 代码见4.4 接收到的消息 receiveMessage message 接收到的消息 4.2.4 平台信息类 查看平台消息服务器信息时返回此平台信息类，获取平台的信息，内容见表4。 表4平台信息类的内容 序号 名称 标识 类型 说明 备注 IP地址 IP string 信息交换平台服务器IP地址 1 2 port long 信息交换平台消息服务器端口号 平台名称 platFormName 3 string 信息交换平台服务器名称 4.2.5消息队列监听器 消息处理方法，信息交换平台客户端开启消息队列监听时，输入此类型的参数，需根据需求由用户 编写该方法，内容见表5。 表5队列监听器的内容 名称 方法名 说 明 一个抽象方法，用户在设置开启监听时，需根据需求编写该方法，用于 消息处理方法 处理平台客户端接收到的消息，如将消息存储到数据库等。该方法输人 process 参数名为msg，类型是message，表示接收到的消息 4.3接口描述 4.3.1 收发消息接口 4.3.1.1收发端联络 收发端联络接口是信息交换平台客户端的构造方法，调用此接口可以定义消息收发方和信息交换 平台服务器IP地址。接口描述见表6，输人输出参数见表7。 3 GA/T1038.3—2012 表6收发端联络接口描述 接口名 接口调用方式 功能说明 接口提供方 gitpClient 信息交换平台客户端 方法调用 收发端联络 表 7 收发端联络输入输出参数 输人输出 参数 类型 说 明 输人 IP string 信息交换平台服务器IP地址 消息发送方或接收方的应用账号，该账号所传的参数是应用编 输人 appAccount string 码。应用编码为应用系统名称与具体部署点信息组成的标识码 输出 4.3.1.2 发送消息 发送消息接口描述见表8，输入输出参数 表8发送消息接口描述 接中名 供方 口调用方式 功能锐明 sendMessage 台客户端 方法调用 发送消息 发送消息输入输出参 输入输出 参数 类型 输人 messag message 发送的消息 输出 MOMResponse 使用getReturnCode()方法获得调用结果代码解发送操作结果 response 4.3.1.3 接收消息 接收消息接口用于单次接收消息，接口描述见表10，输入输出参数见表11。 表10接收消息接口描述 接口名 接口提供方 接口调用方式 功能说明 信息交换平台客户端 方法调用 单次接收消息 receiveMessage 表11 接收消息输入输出参数 输人输出 参数 类型 明 输人 使用getReturnCode()方法获得调用结果代码，了解接收操作结 输出 response MOMResponse 果；使用getReceiveMessage(）方法获得消息体 4 GA/T1038.3—2012 4.3.2设置并开启消息监听接口 开启对消息队列的监听，用于设置并启动监听方式持续接收发送来的消息，直至调用关闭消息监听 接口消息接收才停止。接口描述见表12，输人输出参数见表13。 表12设置并开启消息监听接口描述 接口名 接口提供方 接口调用方式 功能说明 startListener 信息交换平台 方法调用 开始消息队列的监听接收 表13设置并开启消息监听输入输出参数 输入输出 参数 类型 说 明 输人 listene abstractMessageListener 消息队列监听器 使用getReturnCode()方法获得调用结果代码，了解设置 输出 response 和开启监听操作结果 4.3.3 关闭消息监听接口 用于关闭监听方式接 收消息 接口描送 表14，辅 表14 闭消息监听接口描 接口名 接口提保 可谢用方 力能说明 stopListenner 信息交换平台 方法调用 停止消息队列的监听接收 表15 关闭消息监听输入输出参数 输入输出 参数 类型 说 输人 使用getReturnCode(方法获得调用结果代码，了解关闭监听操作 输出 response MOMRespons 4.3.4 应用组信息接口 4.3.4.1 创建某应用用户的应用组 创建某应用用户的应用组接口描述见表16，输人输出参数见表17。 表16创建某应用用户的应用组接口描述 接口名 接口提供方 接口调用方式 功能说明 appGroupRegis