【GA公共安全标准】 消防公共服务平台技术规范第3部分:信息交换接口

ICS35.240
中华人民共和国公共安全行业标准GA/T1038.3-2012
消防公共服务平台技术规范
第3部分：信息交换接口
Technical specifications for the public fire service platform-Part 3:Information exchange interfaces2012-12-27发布
中华人民共和国公安部
2013-01-01实施
GA/T1038.3—2012
GA/T1038《消防公共服务平台技术规范》拟分部分出版，各部分将按照在消防公共服务平台的作用确立。下面列出本标准的预计部分：一第1部分：总体架构及功能要求；第2部分：服务管理接口；
第3部分：信息交换接口；
第4部分：消防综合业务接口；
第5部分：地理信息服务接口。
本部分为GA/T1038的第3部分。
本部分按照GB/T1.1-2009给出的规则起草。本部分由公安部消防局提出。
本部分由公安部计算机与信息处理标准化技术委员会归口。本部分起草单位公安部沈阳消防研究所。本部分主要起草人：姜学赞、朱春玲、张春华、王佩青、梁云杰、吕建波、周蓉蓉、林晓冬。I
1范围
消防公共服务平台技术规范
第3部分：信息交换接口
GA/T1038.3—2012
GA/T1038的本部分规定了消防公共服务平台中信息交换平台（以下简称平台）对消息收发方提供的软件接口（以下简称接口）功能及参数。本部分适用于信息交换平台，以及需使用信息交换平台进行消息发送、接收和订阅的应用实体的开发和应用。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GA/T1038.1一2012消防公共服务平台技术规范第1部分：总体架构及功能要求3术语、定义和缩语
GA/T1038.1一2012界定的术语、定义和缩略语适用于本文件。4平台接口
4.1接口功能
平台提供收发消息接口、设置并开启消息监听接口、关闭消息监听接口、应用组信息接口、本平台信息接口和主题发布订阅信息接口等六类接口，功能如下：a）收发消息接口：用于发送消息和单次接收消息；b）设置并开启消息监听接口：开启对消息队列的监听，用于设置并启动监听方式持续接收发送来的消息，直至调用关闭消息监听接口消息接收才停止；c)
关闭消息监听接口：关闭对消息队列的监听，停止用监听方式接收消息；应用组信息接口：创建和查询应用组信息：平台信息接口：查看平台消息服务器信息；主题发布订阅信息接口：获得主题发布订阅的记录。f)
4.2接口参数
4.2.1类名称和说明
平台接口使用的自定义类名称和说明见表1。GA/T1038.3—2012
message
类名称
MOMResponse
thisPlatFormBean
abstractMessageListener
发送消息类
类名称和说明
发送消息类，具体要求见4.2.2
返回值类，具体要求见4.2.3
平台信息类，具体要求见4.2.4
消息队列监听器，具体要求见4,2.5一类参数的列表
发送消息类定义了发送消息的结构，内容见表2。表2发送消息类的内容
发送方
接收方
消息标识
消息体
消息类型
时效性
优先级
是否婴求回技
回执D
msgStructurelD
messageBody
messageType
expiration
priority
isReceipt
receiptID
string
string
string
string
string
booiean
string
发送方应用账号
接收方的应用账
号（多个应用时，用
“，\隔开）
消息的唯一名称
消息的实际内容
“0\为文本消息、
“2\为回执消息，发
送时无需设置或设
置为0，收到消息需
要判断消息类型是
否为2
消息的有效期，过
期消息将无法到达
目的地
发送方可根据消
息的级别来定义优
用于回执跟踪的
取值范围：
FOREVER一水远有效
WEEK一一周有效
DAY一一天有效
HOUR一一小时有效
MINUTE一一分钟有效
取值范圈：
MIN-一最低优先级
NORM一中级优先级
MAX一最高优先级
要求，true，不要求，false
标识需唯一，具体规则由各
业务系统自己定义
4.2.3返回值类
GA/T1038.3—2012
调用收发消息接口进行收发消息，返回此返回值类，内容见表3。使用收发消息接口发送消息和使用监听方式接收消息时，只返回returnCode：使用收发消息接口接收消息时，返回returnCode和receiveMessage。returnCode为调用结果代码，用于返回调用结果，采用调用结果消息代码，具体见44。表3返回值类的内容
调用结果代码
接收到的消息
平台信息类
returnCode
receiveMessage
string
message
返回调用结果，采用调用结果
消息代码
接收到的消息
查看平台消息服务器信息时返回此平台信息类，获取平台的信息，内容见表4。表4平台信息类的内容
IP地址
端口号
平台名称
platFormName
消息队列监听器
string
string
信息交换平台服务器IP地址
信息交换平台消息服务器端口号信息交换平台服务器名称
调用结果消息
代码见4.4
消息处理方法，信息交换平台客户端开启消息队列监听时，输人此类型的参数，需根据需求由用户编写该方法，内容见表5。
队列监听器的内容
消息处理方法
接口描述
收发消息接口
4.3.1.1收发端联络
方法名
process
一个抽象方法，用户在设置开启监听时，需根据需求编写该方法，用于处理平台客户端接收到的消息，如将消息存储到数据库等。该方法输入参数名为msg，类型是message，表示接收到的消息收发端联络接口是信息交换平台客户端的构造方法，调用此接口可以定义消息收发方和信息交换平台服务器IP地址。接口描述见表6，输入输出参数见表7。3
GA/T1038.3—2012
接口名
gitpClient
输入输出
appAccount
发送消息
表6收发端联络接口描述
接口提供方
信息交换平台客户端
接口调用方式
方法调用
收发端联络输入输出参数
string
string
信息交换平台服务器IP地址
功能说明
收发联络
消息发送方或接收方的应用账号，该账号所传的参数是应用编码。应用编码为应用系统名称与具体部署点信息组成的标识码发送消息接口描述见表8，输人输出参数见表9。表8
发送消息接口描述
接口名
sendMessage
输人输出
message
response
接收消息
接口提供方
信息交换平台客户端
message
MOMResponse
接口测用方式
方法调用
发送消息输入输出参数
发送的消息
功能说明
发送消息
使用getReturnCode(）方法获得调用结果代码，了解发送操作结果接收消息接口用于单次接收消息，接口描述见表10，输人输出参数见表11表10
接口名
receiveMessage
输人输出
response
接口提供方
信息交换平台客户端
MOMResponse
接收消息接口描述
接口调用方式
方法调用
接收消惠输入输出参数
功能说明
单次接收消息
使用getReturnCode(）方法获得调用缩果代码，了解接收操作结果，使用getReceiveMessage（）方法获得消息体4.3.2设置并开启消息监听接口
GA/T1038.3—2012
开启对消息队列的监听，用于设置并启动监听方式持续接收发送来的消息，直至调用关闭消息监听接口消息接收才停止。接口描述见表12，输入输出参数见表13。表12设置并开启消惠监听接口描述接口名
startListener
输人输出
listener
response
接口提供方
信息交换平台
接口调用方式
方法调用
设置并开启消想监听输入输出参数类型
abstractMessageListener
MOMResponse
4.3.3关闭消息监听接口
消息队列监听器
功能说明
开始消息队列的监听接收
使用getReturnCode(）方法获得测用结果代码，了解设置和开启监听操作结果
用于关闭监听方式接收消息，接口描述见表14，输入输出参数见表15。表14关闭消息监听接口描述
接口名
stopListenner
输入输出
response
应用组信息接口
接口提供方
信息交换平台
MOMResponse
创建某应用用户的应用组
接口调用方式
方法调用
关闭消息监听输入输出参数
功能说明
停止消息队列的监听接收
使用getRetumCode()方法获得调用结果代码，了解关闭监听操作结果
创建某应用用户的应用组接口描述见表16，输入输出参数见表17。表16创建某应用用户的应用组接口描述接口名
appGroupRegist
接口提供方
信息交换平台
接口调用方式
WebService调用
功能说明
创建某应用用户的应用组
GA/T1038.3—2012
输人输出
appCode
groupName
groupDese
表17创建某应用用户的应用组输入输出参数类型
string
string
string
string
查询某应用用户的应用组
应用编码
应用组名称
应用组描述信息免费标准bzxz.net
创建成功，返回新增应用组的D，失败，返回1查询某应用用户的应用组接口描述见表18，输入输出参数见表19.表18查询某应用用户的应用组接口描述接口名
queryAllAppGroupsSelf
输入输出
appCode
接口提供方
信息交换平台
接口调用方式
WebService调用
查询某应用用户的应用组输入输出参数类型
string
测除某应用用户的应用组
应用编码
某应用用户的所有应用组信息列表删除某应用用户的应用维接口描述见表20，输人输出参数见表21。表20副除某应用用户的应用组接口描述接口名
deleteAppGroup
输人输出
appCode
groupID
接口提供方
信息交换平台
接口调用方式
WebService调用
副除某应用用户的应用组输入输出参数类型
String
查询所有应用组信息
应用编码
应用组 ID
删除成功，返回1失败，返回一1明
功能说明
查询某应用用户的应用组
功能说明
删除某应用用户的应用组
用于查询信息交换平台已经注册的所有应用组的信息，查询所有应用组信息接口描述见表22，输人输出参数见表23。
接口名
queryAllAppGroups
输人输出
appCode
查询所有应用组信息接口描述
接口提供方
信息交换平台
string
接口调用方式
WebService调用
查询所有应用组信息输入输出参数说
应用编码
所有应用组信息列表
根据应用组编码查询组内所有应用成员明
GA/T1038.3—2012
功能说明
查询所有应用组信息
根据应用组编码查询组内所有应用成员接口描述见表24，输入输出参数见表25。根据应用组编码查询组内所有应用成员接口描述表24
接口名
queryAppsOfGroup
输人输出
appCode
groupID
接口提供方
信息交换平台
接口调用方式
WebService调用
功能说明
根据应用组编码查询组内所有应用成员根据应用组编码查询组内所有应用成员输入输出参数类型
string
应用编码
应用组D
应用组内所有的应用成员信息列表添加某应用用户下应用组内的应用明
添加某应用用户下应用组内的应用接口描述见表26，输入输出参数见表27。表26添加某应用用户下应用组内的应用接口描述接口名
addAppsForGroup
输入输出
appCode
groupID
appIDs
接口提供方
信息交换平台
接口调用方式
WebService调用
功能说明
添加某应用用户下应用组内的应用添加某应用用户下应用组内的应用输入输出参数类型
string
应用编码
应用组ID
应用编码列表
应用组内所有的应用信息列表
GA/T1038.3-—2012
移除某应用用户下应用组内的应用移除某应用用户下应用组内的应用接口描述见表28，输人输出参数见表29。表28移除某应用用户下应用组内的应用接口描述接口名
removeAppsForGroup
输人输出
appCode
groupD
appIDs
接口提供方
信息交换平台
接口用方式
WebService调用
功能说明
移除某应用用户下应用组内的应用移除某应用用户下应用组内的应用输入输出参数类型
string
应用编码
应用组ID
应用编码列表
应用组内所有的应用信息列表
修改某应用用户下应用组内的应用明
修改某应用用户下应用组内的应用接口描述见表30，输人输出参数见表31。表30修改某应用用户下应用组内的应用接口描述接口名
updateAppGroup
输人输出
appCode
groupID
groupName
groupDesc
平台信息接口
接口提供方
信息交换平台
接口调用方式
WebService调用
功能说明
修改某应用用户下应用组内的应用表31
修改某应用用户下应用组内的应用输入输出参数类型
string
string
string
应用编码
应用组ID
应用组名称
应用组描述信息
修改成功，返回1失数，返回一1明
用于查看平台消息服务器信息，平台信息接口描述见表32，输人输出参数见表33，表32
接口名
queryThisPlatlnfo
接口提供方
信息交换平台
平台信息接口描述
接口调用方式
WebService调用
功能说明
查署平台消息服务器信息
输人输出
platBean
表33平台信息输入输出参数
thisPlatFormBean
主题发布订阅信息接口
获取发布主题订阅数量
平台消息服务器的详细信息
获取发布的主题订阅数量接口描述见表34，输人输出参数见表35。获取发布的主题订阅数量接口描述表34
接口名
selectCountForPublish
输人输出
pubName
pubCode
fromTimeStr
toTimeStr
readscope
接口提供方
信息交换平台
接口调用方式
WebService调用
获取发布的主题订阅数量输入输出参数类型
string
string
string
string
string
获取发布主题订阅列表
信息交换平台中的主题名
信息交换平台中的主题编码
开始时间
结束时间
GA/T1038.3—2012
功能说明
获取发布的主题订阅数量
主题范留，取值：0一平台内部，1一平台之间主题数量
获取发布的主题订阅列表接口描述见表36，输入输出参数见表37。结合4.3.6.1返回的主题数量结果，可以进行分页查询主题信息。表36获取发布主题订阅列表接口描述接口名
searchPublish
输入输出
pubName
pubCode
fromTimeStr
接口提供方
信息交换平台
接口调用方式
WebService调用
功能说明
获取发布的主题订阅列表信息
获取发布主题订阅列表输入输出参数类型
string
string
string
信息平台中的主题名
信息平台中的主题编码
开始时间
GA/T1038.3—2012
输入输出
toTimeStr
firstRow
pageSize
readscope
主题订阅
string
表37（续）
结束时间
页记录数
主题范图，取值：0一平台内部，1一平台之间平台已发布的主题订阅列表
主题订阅接口可以订阅指定ID的主题，关联主题所属应用和订阅此主题的用户，接口描述见表38，输人输出参数见表39。
主题订阅接口描述
接口名
regTopieApp
输人输出
topieD
appCode
userName
result
调用结果消息代码
接口提供方
信息交换平台
string
string
boolean
调用结果消息代码及描述见表40。接口调用方式
WebService调用
主题订阅输入输出参数
订阅的主题ID
主题所属应用的应用编码
订阅此主题的用户
操作是否成功，1一成功，0一失败表40调用结果消息代码
操作成功
没有接到消息
没有设置监听
没有连接
IP格式错误
IP为空的
应用编码格式错误
功能说明
执行订阅主题
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。