消防公共服务平台技术规范 第3部分：信息交换接口 GA/T1038.3-2012

前言

GA/T 1038《消防公共服务平台技术规范》拟分部分出版，各部分将按照在消防公共服务平台的作用确立。下面列出本标准的预计部分：
——第1部分：总体架构及功能要求；
——第2部分：服务管理接口；
——第3部分：信息交换接口；
——第4部分：消防综合业务接口；
——第5部分：地理信息服务接口。
本部分为GA/T 1038 的第3部分。
本部分按照GB/T 1.1—2009 给出的规则起草。
本部分由公安部消防局提出。
本部分由公安部计算机与信息处理标准化技术委员会归口。
本部分起草单位：公安部沈阳消防研究所。
本部分主要起草人：姜学赟、朱春玲、张春华、王佩青、梁云杰、吕建波、周蓉蓉、林晓冬。

1 范围

GA/T 1038 的本部分规定了消防公共服务平台中信息交换平台（以下简称平台）对消息收发方提供的软件接口（以下简称接口）功能及参数。
本部分适用于信息交换平台，以及需使用信息交换平台进行消息发送、接收和订阅的应用实体的开发和应用。

2 规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。
GA/T 1038.1一2012  消防公共服务平台技术规范  第1部分：总体架构及功能要求

3 术语、定义和缩略语

GA/T 1038.1—2012 界定的术语、定义和缩略语适用于本文件。

4 平台接口

4.1 接口功能
4.2 接口参数
4.3 接口描述
4.4 调用结果消息代码

4.1 接口功能

平台提供收发消息接口、设置并开启消息监听接口、关闭消息监听接口、应用组信息接口、本平台信息接口和主题发布订阅信息接口等六类接口，功能如下：
a) 收发消息接口：用于发送消息和单次接收消息；
b) 设置并开启消息监听接口：开启对消息队列的监听，用于设置并启动监听方式持续接收发送来的消息，直至调用关闭消息监听接口消息接收才停止；
c) 关闭消息监听接口：关闭对消息队列的监听，停止用监听方式接收消息；
d) 应用组信息接口：创建和查询应用组信息；
e) 平台信息接口：查看平台消息服务器信息；
f) 主题发布订阅信息接口：获得主题发布订阅的记录。

4.2 接口参数

4.2.1 类名称和说明
平台接口使用的自定义类名称和说明见表1。 4.2.2 发送消息类
发送消息类定义了发送消息的结构，内容见表2。 4.2.3 返回值类
调用收发消息接口进行收发消息，返回此返回值类，内容见表3。使用收发消息接口发送消息和使用监听方式接收消息时，只返回returnCode；使用收发消息接口接收消息时，返回returnCode 和re-ceiveMessage。returnCode为调用结果代码，用于返回调用结果，采用调用结果消息代码，具体见4.4。 4.2.4 平台信息类
查看平台消息服务器信息时返回此平台信息类，获取平台的信息，内容见表4。 4.2.5 消息队列监听器
消息处理方法，信息交换平台客户端开启消息队列监听时，输入此类型的参数，需根据需求由用户编写该方法，内容见表5。

4.3 接口描述

4.3.1 收发消息接口
4.3.1.1 收发端联络
收发端联络接口是信息交换平台客户端的构造方法，调用此接口可以定义消息收发方和信息交换平台服务器IP地址。接口描述见表6，输入输出参数见表7。 4.3.1.2 发送消息
发送消息接口描述见表8，输入输出参数见表9。

4.4 调用结果消息代码

调用结果消息代码及描述见表40。