应用间的资源操作URL要求V100713.docx
《应用间的资源操作URL要求V100713.docx》由会员分享，可在线阅读，更多相关《应用间的资源操作URL要求V100713.docx（34页珍藏版）》请在冰豆网上搜索。
应用间的资源操作URL要求V100713
产品名称Productname
密级Confidentialitylevel
HUAWEIBICP
内部公开
产品版本Productversion
Total50pages共50页
V100R001C10
应用间的资源操作URL要求
Preparedby
拟制
Date
日期
2010-07-02
Reviewedby
审核
Date
日期
2010-07-05
Approvedby
批准
Date
日期
yyyy-mm-dd
HuaweiTechnologiesCo.,Ltd.
华为技术有限公司
Allrightsreserved
版权所有XX
（×××/forinternaluseonly）
（×××/仅供内部使用）
RevisionRecord修订记录
Date
日期
RevisionVersion
修订
版本
CRID/DefectID
CR号
SecNo.
修改
章节
ChangeDescription
修改描述
Author
作者
2010-07-13
1.00
initial初稿完成
罗翀烈
Catalog目录
1服务管理中心5
1.1组件需提供其资源的宏参数5
1.2回调URL5
1.3组件服务注册5
1.3.1组件服务注册消息5
1.3.2组件状态消息9
1.3.3组件服务注册11
1.4组件服务卸载12
卸载流程12
1.4.1组件服务流程12
1.5组件服务调用12
1.5.1REST服务调用接口12
1.6组件服务发布和调用REST服务样例13
1.6.1报表的各项资料13
1.6.2对外服务中心的各项资料15
1.6.3服务调用路径URL15
1.7组件服务发布和调用URL服务样例15
1.1.1发帖16
1.1.2看帖18
1.1.3改贴20
1.1.4删贴22
BICP平台集成规范
Keywords关键词：
BICP平台，第三方接入，集成规范
Abstract摘要：
描述了集成到BICP平台需要遵循的规范
Listofabbreviations缩略语清单：
Abbreviations缩略语
Fullspelling英文全名
Chineseexplanation中文解释
BICP
BusinessIntelligenceCorePlatform
商业智能核心平台
REST
RepresentationalStateTransfer
表述性状态转移
1服务管理中心
1.1组件需提供其资源属性的宏参数
发布服务的组件需要提供其资源的宏参数供其他组件拼装回调URL时使用。
如BBS：
有帖子ID、帖子名称。
则报表可以提供宏参数：
${postId}、${postName}
1.2回调URL
当组件在调用其他组件的服务后，希望提供服务的组件在完成操作后能回传一些信息，则需要在调用时将回调URL传入提供服务的组件中。
如：
创建帖子后希望把新创建的帖子ID和帖子名称回传，就需要在调用创建帖子的URL时，将回调的URL也一并传入BBS组件，BBS组件在完成创建帖子的操作后，需要回调URL，传回帖子ID和帖子名称。
1.3组件服务注册
1.3.1组件服务注册消息
该消息用于描述组件内的服务信息，由组件提供获取该消息的路径。
管理员将该获取路径注册到BICP平台，平台定时从该路径获取该组件的服务信息。
组件服务消息格式
标识
组件服务消息
格式
xmlversion="1.0"encoding="utf-8"?
>
操作系统名称
是多少位的操作系统
操作系统版本
操作系统可以使用到的cpu个数
虚拟机供应商
虚拟机名称
虚拟机版本
组件id，需要保证在唯一
服务的发布类型
服务ID
服务uri（相对路径）
...
...
名称
说明
必填
数据类型
长度（字节）
node-info
组件服务信息容器节点
包含以下子节点
address-info
operating-system-info
component-infos
address-info
组件地址信息容器节点
包含以下子节点
local
web
local
本地消息通信的地址和端口节点
包含以下属性
localIP:
本地消息通信的IP地址
如果没有消息通信则填写与Web应用IP地址
是
字符串
15
localPort：
本地消息通信的端口
如果没有消息通信则填写与Web应用端口
是
整形
web
WEB应用地址和端口节点
webIP：
WEB应用的IP地址
是
字符串
15
webPort：
WEB应用的端口
是
整形
context：
WEB应用的上下文
如：
http:
//10.10.10.10:
8080/rpt
context=rpt
是
字符串
20
operating-system-info
操作系统信息容器节点
包含以下子节点：
operating-system-name
operating-system-arch
operating-system-version
available-processors
virtual-machine-vendor
virtual-machine-name
virtual-machine-version
operating-system-name
操作系统名称
否
字符串
50
operating-system-arch
是多少位的操作系统
否
字符串
10
operating-system-version
操作系统版本
否
字符串
50
available-processors
操作系统可以使用到的cpu个数
否
整形
virtual-machine-vendor
虚拟机供应商
否
字符串
50
virtual-machine-name
虚拟机名称
否
字符串
50
virtual-machine-version
虚拟机版本
否
字符串
50
component-infos
组件信息容器节点
包含以下子节点
component-info
component-info
组件信息节点
包含以下子元素
component-type
services
component-type
组件id，需要保证在唯一
是
字符串
100
services
服务信息容器节点
包含以下子节点
service
service
服务信息节点
包含以下子节点
service-type
service-id
service-uri
service-type
服务类型
枚举值：
jaxrs:
rest服务
url:
url服务
是
字符串
10
service-id
服务ID
相同服务的服务ID在同一组件类型下必须保证唯一
是
字符串
100
service-uri
服务uri（相对路径）
如：
以下路径
例子1:
Rest服务
http:
/ip:
port/context/cxf/jaxrs/ReportManager/report
service-uri=/cxf/jaxrs
例子2：
url服务
http:
/ip:
port/context/reportAction.do?
action=create
service-uri=/reportAction.do?
action=create
是
字符串
100
组件服务消息样例
xmlversion="1.0"encoding="utf-8"?
>
WindowsVista
x86
6.1
2
SunMicrosystemsInc.
JavaHotSpot（TM）ClientVM
1.5.0_18
ponent.rpt
jaxrs
ReportManager
/cxf/jaxrs
url
createReport
/reportAction.do?
action=create
1.3.2组件状态消息
该消息用于描述组件的当前状态信息，由组件提供获取该消息的路径。
管理员将该获取路径注册到BICP平台，平台定时从该路径获取该组件的状态信息。
用于确定该组件是否可用。
组件状态消息格式
标识
组件服务消息
格式
xmlversion="1.0"encoding="UTF-8"?
>
服务器的状态信息（系统保留）
当前组件实例虚拟机的最大内存
当前组件实例虚拟机的已使用内存
当前组件实例虚拟机的剩余内存
组件类型
...
名称
说明
必填
数据类型
长度（字节）
statistics
状态信息节点
包含以下子节点
address-info
host-statistics
node-statistics
component-statistics
address-info
组件地址信息容器节点
包含以下子节点
local
local
本地消息通信的地址和端口节点
包含以下属性
localIP:
本地消息通信的IP地址
如果没有消息通信则填写与Web应用IP地址
是
字符串
15
localPort：
本地消息通信的端口
如果没有消息通信则填写与Web应用端口
是
整形
host-statistics
服务器的状态信息（系统保留）
否
node-statistics
当前组件实例虚拟机的状态
包含以下子节点：
max-memory
total-memory
free-memory
max-memory
当前组件实例虚拟机的最大内存
单位（Mb）
否
整形
total-memory
当前组件实例虚拟机的已使用内存
单位（Mb）
否
整形
free-memory
当前组件实例虚拟机的剩余内存
单位（Mb）
否
整形
component-statistics
组件状态容器
component-statistic
组件状态
component-type
组件类型
是
字符串
100
组件状态消息样例
xmlversion="1.0"encoding="UTF-8"?
>
1024
512
512
ponent.rpt
1.3.3组件服务注册
应用开发人员完成组件注册消息和组件状态消息开发后，将这两个信息的获取路径提交给管理员，由管理员在BICP平台上注册。
注册流程
（1）应用开发人员发布获取组件注册消息的路径
（2）应用开发人员发布获取组件状态消息的路径
（3）管理员进入组件服务注册页面填写获取组件注册消息和组件状态消息URL
（4）系统自动到组件获取XML信息进行服务注册
1.4组件服务卸载
卸载流程
（1）管理员进入组件服务管理页面
（2）管理员停用/卸载要停用的组件
1.4.1组件服务流程
【组件服务注册页面】
管理员进入组件服务注册页面，点击“删除”按钮卸载组件服务
1.5组件服务调用
1.5.1REST服务调用接口
接口发布形式：
REST
调用方式：
GET/POST/PUT/DELETE
URL地址：
http:
//服务中心IP地址:
端口号/服务中心应用名/proxyexecutor?
user=用户ID&pswd=密码&componentType=组件类型&serviceId=服务ID&path=服务的路径和参数
URL描述
名称
样例值
服务中心IP地址
10.10.10.10
端口号
8080
服务中心应用名
proxyexecutor（默认值）
proxyexecutor
服务调用Servlet地址
user
用户ID
pswd
密码
componentType
组件类型
serviceId
服务ID
path
调用该服务的路径及参数。
注：
该参数需经过URL编码（编码格式UTF8），以便传递特殊字符
1.6组件发布和调用REST服务样例
样例：
报表组件将通过组件中心发布获取报表数据的Res服务
1.6.1报表的各项资料
项目
样例值
描述
报表WebIP
10.10.10.10
报表Web应用的IP地址
报表WebPort
8080
报表Web应用的端口
报表应用上下文
rpt
报表应用上下文
获取报表数据的服务绝对路径
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
xmlversion="1.0"encoding="utf-8"?
>
WindowsVista
x86
6.1
2
SunMicrosystemsInc.
JavaHotSpot（TM）ClientVM
1.5.0_18
ponent.rpt
jaxrs
ReportManager
升级会员 