当前位置: 首页 / 发现 / 政策规范 / 正文

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

来源:发布时间:2018/7/19

前言


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.3.1.3 接收消息
接收消息接口用于单次接收消息,接口描述见表10,输入输出参数见表11。
接收消息接口描述
接收消息输入输出参数
4.3.2 设置并开启消息监听接口
开启对消息队列的监听,用于设置并启动监听方式持续接收发送来的消息,直至调用关闭消息监听接口消息接收才停止。接口描述见表12,输入输出参数见表13。
设置并开启消息监听接口描述
设置并开启消息监听输入输出参数
4.3.3 关闭消息监听接口
用于关闭监听方式接收消息,接口描述见表14,输入输出参数见表15。
关闭消息监听接口描述
关闭消息监听输入输出参数
4.3.4 应用组信息接口
4.3.4.1 创建某应用用户的应用组
创建1某应用用户的应用组接口描述见表16,输入输出参数见表17。
创建某应用用户的应用组接口描述
创建某应用用户的应用组输入输出参数
4.3.4.2 查询某应用用户的应用组
查询某应用用户的应用组接口描述见表18,输入输出参数见表19。
查询某应用用户的应用组接口描述
查询某应用用户的应用组输入输出参数
4.3.4.3 删除某应用用户的应用组
删除某应用用户的应用组接口描述见表20,输入输出参数见表21。
删除某应用用户的应用组接口描述
删除某应用用户的应用组输入输出参数
4.3.4.4 查询所有应用组信息
用于查询信息交换平台已经注册的所有应用组的信息,查询所有应用组信息接口描述见表22,输入输出参数见表23。
查询所有应用组信息接口描述
查询所有应用组信息输入输出参数
4.3.4.5 根据应用组编码查询组内所有应用成员
根据应用组编码查询组内所有应用成员接口描述见表24,输入输出参数见表25。
根据应用组编码查询组内所有应用成员接口描述
根据应用组编码查询组内所有应用成员输入输出参数
4.3.4.6 添加某应用用户下应用组内的应用
添加某应用用户下应用组内的应用接口描述见表26,输入输出参数见表27。
添加某应用用户下应用组内的应用接口描述
添加某应用用户下应用组内的应用输入输出参数
4.3.4.7 移除某应用用户下应用组内的应用
移除某应用用户下应用组内的应用接口描述见表28,输入输出参数见表29。
移除某应用用户下应用组内的应用接口描述
移除某应用用户下应用组内的应用输入输出参数
4.3.4.8 修改某应用用户下应用组内的应用
修改某应用用户下应用组内的应用接口描述见表30,输入输出参数见表31。
修改某应用用户下应用组内的应用接口描述
修改某应用用户下应用组内的应用输入输出参数
4.3.5 平台信息接口
用于查看平台消息服务器信息,平台信息接口描述见表32,输入输出参数见表33。
平台信息接口描述
平台信息输入输出参数
4.3.6 主题发布订阅信息接口
4.3.6.1 获取发布主题订阅数量
获取发布的主题订阅数量接口描述见表34,输入输出参数见表35。
获取发布的主题订阅数量接口描述
获取发布的主题订阅数量输入输出参数
4.3.6.2 获取发布主题订阅列表
获取发布的主题订阅列表接口描述见表36,输入输出参数见表37。结合4.3.6.1返回的主题数量结果,可进行分页查询主题信息。
获取发布主题订阅列表接口描述
获取发布主题订阅列表输入输出参数
获取发布主题订阅列表输入输出参数(续)
4.3.6.3 主题订阅
主题订阅接口可以订阅指定ID的主题,关联主题所属应用和订阅此主题的用户。接口描述见表38,输入输出参数见表39。
主题订阅接口描述
主题订阅输入输出参数


4.4 调用结果消息代码


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