db11 t 553.5-2008 政务信息资源共享交换平台技术规范 第5部分 接口规范

政务信息资源共享交换平台技术规范第5部分：接口规范TechnicalspecificationforgovernmentinformationresourcesharingandinterchangeplatformPart5:Interfacespecification北京市地方标准ICS01.040.35L72备案号xx-xxxx2008-05-28发布2008-07-01实施北京市质量技术监督局发布DBDB11/T553.5—2008DB11/T553.5—2008I目次前言......................................................................................................................................................................II1范围..................................................................................................................................................................12规范性引用文件............................................................................................................错误！未定义书签。3概述..................................................................................................................................................................14政务信息资源目录服务接口..........................................................................................................................15政务信息资源交换服务接口...........................................................................................................................56认证授权服务接口.........................................................................................................................................10附录A（规范性附录）政务信息资源目录服务接口XMLSchema描述....................................................11附录B（规范性附录）政务信息资源交换服务接口XMLSchema描述....................................................18DB11/T553.5—2008II前言DB11/T553《政务信息资源共享交换平台技术规范》，分为5个部分：――第1部分：总体框架；――第2部分：政务信息资源目录管理；――第3部分：政务信息资源交换管理；――第4部分：认证授权；――第5部分：接口规范。本部分为DB11/T553的第5部分。本标准的附录A、附录B为规范性附录。本部分由北京市信息化工作办公室提出并归口。本部分的起草单位：北京市信息资源管理中心、中科软科技股份有限公司、北京数贝软件科技有限公司。本部分主要起草人：黄晓斌、林绍福、冯启民、程军、郭家义、崔建新、赵琰昉、李海蛟、李清、徐伟、李中、韩霖。DB11/T553.5—20081政务信息资源共享交换平台技术规范第5部分：接口规范1范围本部分规定了政务信息资源共享交换平台的接口规范，包括政务信息资源目录服务接口、政务信息资源交换服务接口和认证授权服务接口。本部分适用于政务信息资源共享交换平台建设的规划、设计和实施。2概述2.1接口组成政务信息资源共享交换平台提供政务信息资源目录服务接口、政务信息资源交换服务接口和认证授权服务接口等三类接口。政务信息资源共享交换平台接口组成见图1。图1政务信息资源共享交换平台接口组成2.2接口技术要求a）应至少提供JMS和Web服务接口；b）应支持跨语言、跨操作系统调用。3政务信息资源目录服务接口3.1目录检索接口3.1.1用户目录检索接口根据指定的检索条件和用户访问权限对政务信息资源目录数据进行查询，并返回结果。用户目录检索接口参数说明见表1。表1用户目录检索接口参数表参数名称参数类型可选/必选参数含义Query政务信息资源目录查询对象MetaQuery数组必选用于存放查询条件的值对象。说明：MetaQuery查询条件为非空字符串，MetaQuery内部的参数为“与”的关系，MetaQuery之间为“或”的关系usercodeString必选用户ID，政务信息资源目录管理系统根据用户访问权限对DB11/T553.5—20082查询结果进行过滤a）返回值：政务信息资源目录数据对象MetaData数组；b）政务信息资源目录数据对象MetaData的XMLSchema定义见附录A.1；c）政务信息资源目录数据对象MetaData的组成结构见图2；d）政务信息资源目录查询对象MetaQuery的XMLSchema定义见附录A.2；e）政务信息资源目录查询对象MetaQuery的组成结构见图3。DB11/T553.5—20083图2政务信息资源目录数据对象MetaData的组成结构图DB11/T553.5—20084图3政务信息资源目录查询对象MetaQuery的组成结构图DB11/T553.5—200853.1.2角色目录检索接口根据检索条件和角色访问权限对政务信息资源目录数据进行查询，并返回结果。角色目录检索接口参数说明见表2。表2角色目录检索接口参数表参数名称参数类型可选/必选参数含义Query政务信息资源目录查询对象MetaQuery数组必选用于存放查询条件的值对象。说明：MetaQuery查询条件为非空字符串，MetaQuery内部的参数为“与”的关系，MetaQuery之间为“或”的关系Rolecodestring必选用户角色ID，政务信息资源目录管理系统根据角色访问权限对查询结果进行过滤a）返回值：政务信息资源目录数据对象MetaData数组；b）政务信息资源目录数据对象MetaData的XMLSchema定义见附录A.1；c）政务信息资源目录数据对象MetaData的组成结构见图2；d）政务信息资源目录查询对象MetaQuery的XMLSchema定义见附录A.2；e）政务信息资源目录查询对象MetaQuery的组成结构见图3。3.2目录注册更新接口根据权限实现符合规范的政务信息资源目录数据的注册、更新，并返回注册或更新成功的政务信息资源目录数据的元数据标识符。目录注册更新接口参数说明见表3。表3目录注册更新接口参数表参数名称参数类型可选/必选参数含义RegisterData政务信息资源目录数据对象MetaData数组必选请求目录注册、目录更新的政务信息资源目录数据对象Usercodestring必选用户ID，用于检验用户是否有权限进行目录注册或目录更新操作isRegisterBoolean必选TRUE表示目录注册，FALSE表示目录更新a）返回值：如果注册或更新成功，返回注册或更新成功的政务信息资源目录数据的元数据标识符；如果失败，返回-1；b）政务信息资源目录数据对象MetaData的XMLSchema定义见附录A.1；c）政务信息资源目录数据对象MetaData的组成结构见图2。4政务信息资源交换服务接口4.1数据库交换接口4.1.1数据库交换请求接口将数据库交换请求信息发送到交换中心，并在发送数据的交换节点与接收数据的交换节点之间建立会话。数据库交换请求接口参数说明见表4。表4数据库交换请求接口参数表参数名称参数类型可选/必选参数含义Message数据库交换请求对象DBExRequest必选数据库交换请求信息DB11/T553.5—20086参数名称参数类型可选/必选参数含义deliveryModeint可选采用的传送模式，支持的传送模式至少应包括持续传送模式PERSISTENT和一次性传送模式NON_PERSISTENTPriorityint可选请求的优先级，共有10个优先级。0是最低优先级，9是最高优先级。默认的优先级是4timeToLiveint可选请求的存在时间，单位为毫秒，由发送方指定，0为无限制a）返回值：TRUE表示发送成功，FALSE表示发送失败；b）数据库交换请求对象DBExRequest的XMLSchema定义见附录B.1；c）数据库交换请求对象DBExRequest的组成结构见图4。图4数据库交换请求对象DBExRequest的组成结构图4.1.2数据库数据发送接口将需交换的数据库数据发送给接收数据的交换节点。数据库数据发送接口参数说明见表5。表5数据库数据发送接口参数表参数名称参数类型可选/必选参数含义dbData数据库交换数据对象DBExData必选需要通过数据库数据发送接口发送的数据集a）返回值：无；b）数据库交换数据对象DBExData的XMLSchema定义见附录B.2；c）数据库交换数据对象DBExData的组成结构见图5。DB11/T553.5—20087图5数据库交换数据对象DBExData的组成结构图4.1.3数据库数据接收接口接收从提供数据的交换节点发送的数据库数据。数据库数据接收接口参数说明见表6。表6数据库数据接收接口参数表参数名称参数类型可选/必选参数含义dbData数据库交换数据对象DBExData必选需要通过数据库数据接收接口接收的数据集a）返回值：无；b）数据库交换数据对象DBExData的组成结构见图5；c）数据库交换数据对象DBExData的XMLSchema定义见附录B.2。4.2文件交换接口4.2.1文件交换请求接口将文件交换请求信息发送到交换中心，并在发送数据的交换节点与接收数据的交换节点之间建立会话。文件交换请求接口参数说明见表7。表7文件交换请求接口参数表参数名称参数类型可选/必选参数含义Message文件交换请求对象FileExRequest必选文件交换请求信息DB11/T553.5—20088参数名称参数类型可选/必选参数含义deliveryModeInt可选采用的传送模式，支持的传送模式至少应包括持续传送模式PERSISTENT和一次性传送模式NON_PERSISTENTPriorityInt可选请求的优先级，共有10个优先级。0是最低优先级，9是最高优先级。默认的优先级是4timeToLiveInt可选请求的存在时间，单位为毫秒，由发送方指定，0为无限制a）返回值：TRUE表示发送成功，FALSE表示发送失败；b）文件交换请求对象FileExRequest的XMLSchema定义见附录B.3；c）文件交换请求对象FileExRequest的组成结构见图6。图6文件交换请求对象FileExRequest的组成结构图4.2.2文件数据发送接口将需交换的文件数据发送给接收数据的交换节点。文件数据发送接口参数说明见表8。表8文件数据发送接口参数表参数名称参数类型可选/必选参数含义fData文件交换数据对象FileExData必选需要通过文件数据发送接口发送的数据集DB11/T553.5—20089a）返回值：无；b