应用间的资源操作URL要求V100713.docx

1、应用间的资源操作URL要求V100713产品名称Product name密级Confidentiality levelHUAWEI BICP内部公开产品版本Product versionTotal 50pages共50页V100R001C10应用间的资源操作URL要求Prepared by 拟制Date日期2010-07-02Reviewed by 审核Date日期2010-07-05Approved by批准Date日期yyyy-mm-ddHuawei Technologies Co., Ltd. 华为技术有限公司All rights reserved版权所有XX（ / for intern

2、al use only）（ / 仅供内部使用）Revision Record 修订记录Date日期Revision Version修订版本CR ID / Defect IDCR号Sec No. 修改章节Change Description修改描述Author作者2010-07-131.00initial 初稿完成罗翀烈Catalog 目录1 服务管理中心 51.1 组件需提供其资源的宏参数 51.2 回调URL 51.3 组件服务注册 51.3.1 组件服务注册消息 51.3.2 组件状态消息 91.3.3 组件服务注册 111.4 组件服务卸载 12卸载流程 121.4.1 组件服务流程 1

3、21.5 组件服务调用 121.5.1 REST服务调用接口 121.6 组件服务发布和调用REST服务样例 131.6.1 报表的各项资料 131.6.2 对外服务中心的各项资料 151.6.3 服务调用路径URL 151.7 组件服务发布和调用URL服务样例 151.1.1 发帖 161.1.2 看帖 181.1.3 改贴 201.1.4 删贴 22BICP平台集成规范Keywords 关键词：BICP平台，第三方接入，集成规范Abstract 摘要：描述了集成到BICP平台需要遵循的规范List of abbreviations 缩略语清单：Abbreviations缩略语Full sp

4、elling 英文全名Chinese explanation 中文解释BICPBusiness Intelligence Core Platform商业智能核心平台RESTRepresentational State Transfer表述性状态转移1 服务管理中心1.1 组件需提供其资源属性的宏参数发布服务的组件需要提供其资源的宏参数供其他组件拼装回调URL时使用。如BBS：有帖子ID、帖子名称。则报表可以提供宏参数：$postId、$postName1.2 回调URL当组件在调用其他组件的服务后，希望提供服务的组件在完成操作后能回传一些信息，则需要在调用时将回调URL传入提供服务的组件中。如

5、：创建帖子后希望把新创建的帖子ID和帖子名称回传，就需要在调用创建帖子的URL时，将回调的URL也一并传入BBS组件，BBS组件在完成创建帖子的操作后，需要回调URL，传回帖子ID和帖子名称。1.3 组件服务注册1.3.1 组件服务注册消息该消息用于描述组件内的服务信息，由组件提供获取该消息的路径。管理员将该获取路径注册到BICP平台，平台定时从该路径获取该组件的服务信息。组件服务消息格式标识组件服务消息格式 操作系统名称 是多少位的操作系统 操作系统版本 操作系统可以使用到的cpu个数 虚拟机供应商 虚拟机名称 虚拟机版本 组件id，需要保证在唯一 服务的发布类型 服务ID 服务uri（相对

6、路径） . . 名称说明必填数据类型长度（字节）node-info组件服务信息容器节点包含以下子节点address-infooperating-system-infocomponent-infosaddress-info组件地址信息容器节点包含以下子节点localweblocal本地消息通信的地址和端口节点包含以下属性localIP: 本地消息通信的IP地址如果没有消息通信则填写与Web应用IP地址是字符串15localPort：本地消息通信的端口如果没有消息通信则填写与Web应用端口是整形webWEB应用地址和端口节点webIP：WEB应用的IP地址是字符串15webPort：WEB应用的端

7、口是整形context：WEB应用的上下文如：http:/10.10.10.10:8080/rptcontext=rpt是字符串20operating-system-info操作系统信息容器节点包含以下子节点：operating-system-nameoperating-system-archoperating-system-versionavailable-processorsvirtual-machine-vendorvirtual-machine-namevirtual-machine-versionoperating-system-name操作系统名称否字符串50operating-s

8、ystem-arch是多少位的操作系统否字符串10operating-system-version操作系统版本否字符串50available-processors操作系统可以使用到的cpu个数否整形virtual-machine-vendor虚拟机供应商否字符串50virtual-machine-name虚拟机名称否字符串50virtual-machine-version虚拟机版本否字符串50component-infos组件信息容器节点包含以下子节点component-infocomponent-info组件信息节点包含以下子元素component-typeservicescomponent

9、-type组件id，需要保证在唯一是字符串100services服务信息容器节点包含以下子节点serviceservice服务信息节点包含以下子节点service-typeservice-idservice-uriservice-type服务类型枚举值：jaxrs: rest服务url: url服务是字符串10service-id服务ID相同服务的服务ID在同一组件类型下必须保证唯一是字符串100service-uri服务uri（相对路径）如：以下路径例子1:Rest服务http:/ip:port/context/cxf/jaxrs/ReportManager/reportservice-ur

10、i =/cxf/jaxrs例子2：url服务http:/ip:port/context/reportAction.do?action=createservice-uri=/reportAction.do?action=create是字符串100组件服务消息样例 Windows Vista x86 6.1 2 Sun Microsystems Inc. Java HotSpot(TM) Client VM 1.5.0_18 ponent.rpt jaxrs ReportManager /cxf/jaxrs url createReport /reportAction.do?action=crea

11、te 1.3.2 组件状态消息该消息用于描述组件的当前状态信息，由组件提供获取该消息的路径。管理员将该获取路径注册到BICP平台，平台定时从该路径获取该组件的状态信息。用于确定该组件是否可用。组件状态消息格式标识组件服务消息格式 服务器的状态信息（系统保留） 当前组件实例虚拟机的最大内存 当前组件实例虚拟机的已使用内存 当前组件实例虚拟机的剩余内存 组件类型 . 名称说明必填数据类型长度（字节）statistics状态信息节点包含以下子节点address-infohost-statisticsnode-statisticscomponent-statisticsaddress-info组件地址

12、信息容器节点包含以下子节点locallocal本地消息通信的地址和端口节点包含以下属性localIP: 本地消息通信的IP地址如果没有消息通信则填写与Web应用IP地址是字符串15localPort：本地消息通信的端口如果没有消息通信则填写与Web应用端口是整形host-statistics服务器的状态信息（系统保留）否node-statistics当前组件实例虚拟机的状态包含以下子节点：max-memorytotal-memoryfree-memorymax-memory当前组件实例虚拟机的最大内存单位（Mb）否整形total-memory当前组件实例虚拟机的已使用内存单位（Mb）否整形fr

13、ee-memory当前组件实例虚拟机的剩余内存单位（Mb）否整形component-statistics组件状态容器component-statistic组件状态component-type组件类型是字符串100组件状态消息样例 1024 512 512 ponent.rpt 1.3.3 组件服务注册应用开发人员完成组件注册消息和组件状态消息开发后，将这两个信息的获取路径提交给管理员，由管理员在BICP平台上注册。注册流程（1） 应用开发人员发布获取组件注册消息的路径（2） 应用开发人员发布获取组件状态消息的路径（3） 管理员进入组件服务注册页面填写获取组件注册消息和组件状态消息URL（4）

14、系统自动到组件获取XML信息进行服务注册1.4 组件服务卸载卸载流程（1） 管理员进入组件服务管理页面（2） 管理员停用/卸载要停用的组件1.4.1 组件服务流程【组件服务注册页面】管理员进入组件服务注册页面，点击“删除”按钮卸载组件服务1.5 组件服务调用1.5.1 REST服务调用接口接口发布形式：REST调用方式：GET/POST/PUT/DELETEURL地址：http:/服务中心IP地址:端口号/服务中心应用名/proxyexecutor?user=用户ID&pswd=密码&componentType=组件类型&serviceId=服务ID&path=服务的路径和参数URL描述名称样

15、例值服务中心IP地址10.10.10.10端口号8080服务中心应用名proxyexecutor（默认值）proxyexecutor服务调用Servlet地址user用户IDpswd密码componentType组件类型serviceId服务IDpath调用该服务的路径及参数。注：该参数需经过URL编码（编码格式UTF8），以便传递特殊字符1.6 组件发布和调用REST服务样例样例：报表组件将通过组件中心发布获取报表数据的Res服务1.6.1 报表的各项资料项目样例值描述报表WebIP10.10.10.10报表Web应用的IP地址报表WebPort8080报表Web应用的端口报表应用上下文rp

16、t报表应用上下文获取报表数据的服务绝对路径http:/10.10.10.10:8080/rpt/cxf/jaxrs/ReportManager/report/reportId获取报表组件服务信息的路径http:/10.10.10.10:8080/rpt/cxf/jaxrs/ComponentService/service获取报表组件状态信息的路径http:/10.10.10.10:8080/rpt/cxf/jaxrs/StatisticService/statistics报表组件服务XML Windows Vista x86 6.1 2 Sun Microsystems Inc. Java HotSpot(TM) Client VM 1.5.0_18 ponent.rpt jaxrs ReportManager ser