《分布式资源网平台概要设计说明书.doc》由会员分享，可在线阅读，更多相关《分布式资源网平台概要设计说明书.doc（25页珍藏版）》请在三一文库上搜索。
1、1引言21.1编写目的21.2背景21.3定义21.4参考资料22总体设计22.1需求规定22.2运行环境22.3基本设计概念和处理流程32.4结构32.5功能器求与程序的关系32.6人工处理过程32.7尚未问决的问题33接口设计33.1用户接口33.2外部接口33.3内部接口44运行设计44.1运行模块组合44.2运行控制44.3运行时间45系统数据结构设计45.1逻辑结构设计要点45.2物理结构设计要点45.3数据结构与程序的关系46系统出错处理设计56.1出错信息56.2补救措施56.3系统维护设计5概要设计说明书1引言1.1编写目的该文档描述了针对用户需求系统的概要情况，本文档适用于用
2、户业务专家（专指在教育教学资源建设方面的业务专家）、软件系统分析员以及软件测试人员。1.2背景说明：a. 该软件系统名称为深圳市教育资源网系统（ShenZhen Education Resource Network，简称为SZERNET）。b. 该系统由深圳市电化教育馆提出需求，由北京师范大学现代化教育技术研究所、北京市校际通信息技术有限公司、深圳市电化教育馆联合开发，软件开发完成以后，在深圳市电化教育馆的计算机中心机房运行。1.3定义n 资源元数据：描述一条资源的各类属性信息，叫资源元数据。n 资源属性：即资源元数据，教育教学过程中、以及资源使用过程中人们的口头语。n 资源文件：资源的物理存
3、在方式，例如一个磁盘文件（目前最为普通的方式）。n 资源站点：提供资源访问功能的站点叫资源站点。资源站点的概念是相对的，不是绝对的。n 资源站点之间的互操作：资源站点之间不是独立的，而是能够通过某些公用的接口，来进行透明化的数据交流，这样的关系叫做资源站点之间的互操作。n 资源网：将多个资源站点连接在一起，成树状结构，提供资源站点的互操作，这样的体系叫做资源网。n 站点注册中心：用来维护资源网中，各个资源站点之间的关系的某类特殊站点，叫做站点注册中心。n 资源同步：通过某种公用的接口，来将某个资源站点（或者某批资源站点）的资源元数据的信息汇集到资源中心（前提是这些资源站点必须已经向该资源中心的
4、站点注册中心注册过），并且保持这些资源元数据的同步，这个过程叫做资源同步。资源同步并不将所有的资源文件同步到资源中心去。n 资源中心：配置有站点注册中心等能够对其范围内的资源站点间发出资源同步请求的资源站点，叫做资源中心。资源中心不是绝对的，而是相对的。n 系统管理员：资源站点或者资源中心的管理员，最高权限者。n 资源审核专家：对资源进行审核的人，还能对资源进行管理，但往往只能对某类资源进行该操作。n 地区管理员：能够对位于某地区的用户进行管理。n 资源同步管理员：能够对资源同步过程中进行控制的人，在资源站点，该管理员能够将这个资源站点的信息注册、修改、注销在站点注册中心上，在资源中心，该管理
5、员能够设置各种同步所属资源站点资源的各种开关，并发出开始、停止同步命令。n 资源导入导出人员：能够将资源导入、导出到资源站点。n 访客 guest：没有注册的系统使用者，很多功能受到限制。例如，不能拥有自己的收藏夹，不能上传资源、不能设置自己喜欢的资源范围等。n 资源视图：某种类别的资源分类，用来关联一批资源和资源视图，方便终端用户的使用。资源视图与资源的物理存放没有关系。n 存储单元：在服务器端真正保存资源的最小管理单位。n 永久资源（正式资源）：已经经过审核的资源，可能是上传的资源已经通过了审核，也可能是导入的资源已经通过了审核。n 上载资源：用户通过http协议，上传一条资源，在没有得到
6、资源审核专家的审核以前，该资源叫上载资源。n 临时资源：上载资源或者永久资源，被删除以后，叫做临时资源。在以后系统扩展的时候，可以用来实现“回收站”功能，来回收被错误删除的资源。n 同步系统：对资源同步服务器端和资源同步客户端程序的统称，该系统能够将资源元数据同步到资源中心来。1.4参考资料a. 合同；开发计划书；b. 国家标准化委员会资源属性标注n http:/:8082/celtsc/n CELTS-3n CELTS-41c. 软件开发标准J2EE规范1.2Software Engineering A Practitioners Approach, Fourth EditionJ2EE服务
7、器端高级编程d. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2总体设计2.1需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。输入/输出项目描述性能要求资源导入能够将基于国家标准资源描述的资源导入到本系统，至少需要支持两种格式：n 北京校际通公司的资源描述格式n 标委会的资源描述格式能够在服务器端处理海量资源。资源导出能够将本系统中的资源导出为北京校际通公司的资源描述格式。（考虑到保护资源提供上的版权，我们不提供导出为基于标委会的资源描述格式的资源的功能）能够在
8、服务器端处理海量资源。资源同步的服务器端接口能够对资源同步的请求进行响应，将本地资源的属性信息通过网络进行发送，该接口为Web Service 接口。能够在服务器端长时间处理海量资源，后台运行，不要求高性能。2.2运行环境本系统对硬件环境的需求推荐：数据库服务器24路CPU，频率在700M以上，内存4G应用服务器2路CPU，频率在700M以上，内存8G本系统运行操作系统推荐：本系统可以运行在主流操作系统之上，例如，Unix (IBM AIX 4.3.3), Linux (Red Hat 7.2), Windows (Windows 2000 Server)。推荐使用IBM AIX 4.3.3。
9、本系统运行软件：数据库：采用Oracle9i Enterprise应用服务器：采用WebSphere Application Advanced Server, Edition 4(Fix Pack 4以上)推荐数据库服务器和应用服务器运行在单独的服务器上。2.3基本设计概念和处理流程系统基本设计概念(1) 编程框架在J2EE开发规范的基础上，我们采用IBM的Business Framework开发框架（4层开发体系），所有表现层都采用JSP来进行显示，所有的流程控制都采用Servlet来完成（充分利用MVC的开发模式），对于用户需求中的每一个具体的使用案例的商务逻辑，我们都采用一个专门的Com
10、mand Bean和一个Session Bean来对其进行包装，对于数据库的访问，在访问单条数据库记录（且限于单表的情况）的时候，我们采用Entity Bean（这样做，我们能够大幅度提高开发效率），其他情况，为了提高访问效率，我们采用直接JDBC连接的方式来进行。(2) 系统体系划分分布式资源网平台的开发需要按照三个步骤来进行。n 实现传统资源库功能的开发采用传统的开发方式开发传统资源库的功能，例如，对资源的浏览、使用、收藏、下载等。n 定义资源库互操作的接口，并根据接口实现资源库服务器端功能该服务器端能够对接口实行响应，以纯XML数据流或者Web Service接口的方式来实现资源库之间互
11、操作的接口。n 根据资源库互操作的接口实现资源库客户端的功能更新传统资源库的实现方式，将需要资源库互操作的所有传统实现更新为针对纯XML流或者Web Service接口的实现。系统基本处理流程（1）资源库中资源的建设问题n 允许普通用户通过HTTP协议远程上载资源。n 允许导入资源（用来满足用户购买商业教学资源的需求）。这样的海量资源，在服务器端进行，要求程序运行稳定，性能优良，能够灵活配置，以适应各地的不同部署环境。n 必须考虑到将来的资源访问收费问题，必须留下实现该功能的足够接口。（2）资源库中资源的管理问题n 在逻辑上，资源可以存放在三个地方，临时资源库（用来存放临时的资源，例如，删除的
12、资源等），上载资源库（用户上载的资源，还没有通过审核的），永久资源库（用户购买的资源，用户上载并且经过审核的资源）。n 在物理上，资源存放在磁盘（阵列）上。对于临时资源库，上载资源库，永久资源库来说，都需要一个资源存储管理系统，临时资源库对应着临时资源存储管理系统，上载资源库对应着上载资源存储管理系统，永久资源库对应着永久资源存储管理系统。对于任何一个存储管理系统，应该提供建立/修改/删除单个存储单元或建立批量存储单元的功能。n 用户上载的资源首先保存在上载资源库，经过资源审核专家审核以后保存在永久资源库。永久资源库和上载资源库里面的资源，审核专家或者资源管理员删除以后，保存在临时资源库。n
13、在分布式前提下，各个地方的资源是各自管理的。2.4结构（1）技术路线Session BeansHTMLJSPServletCommandBrowserEntity BeansDBResourceJava Beans图2.4.1.1技术路线图（2）功能模块基本系统之终端用户（主要功能模块）图2.4.2.1基本系统之终端用户的前台使用图2.4.2.2基本系统之终端用户的资源浏览图2.4.2.3基本系统之终端用户的资源查看基本系统之后台管理图2.4.2.4基本系统之系统管理图2.4.2.5基本系统之资源审核专家图2.4.2.6基本系统之地区用户管理扩展系统之终端用户图2.4.2.7扩展系统之资源浏览
14、(1)图2.4.2.8扩展系统之资源浏览(2)图2.4.2.9扩展系统之资源检索扩展系统之后台管理图2.4.2.10扩展系统之资源导入/导出图2.4.2.10扩展系统之站点注册图2.4.2.11扩展系统之后台服务（3）每个系统元素的扼要说明 编号系统元素名称英文名称扼要说明基本系统用户/角色A_001终端用户Web Site User使用资源网的普通用户，包括注册用户和访客（GUEST）A_002系统管理员System Manager系统后台维护人员，资源站点的最高权限者A_003资源审核专家Expert资源审核专家，能够对指定属性的资源进行资源管理、审核、专家评论扩展系统用户/角色A_004
15、地区管理员Area Manager能够对本资源站点该地区的注册用户进行管理、审核A_005资源导入/导出员Importer/Exporter能够将系统资源导出为标准的xml格式，也能将符合标准格式的xml资源导入到本资源站点A_006站点同步管理员Site Synchronization Manager能够进行站点注册、审核、管理的站点注册中心管理人员。基本系统中的前台应用F_001资源浏览系统Browsing Resource MataData Info.浏览资源站点中的资源F_002用户通信模块Send Messages to others注册用户可以通过这个发消息模块，互相通信F_003
16、资源上传Upload上载资源F_004购买资源Buy Resources通过付费的方式使用资源F_005修改用户信息Modify User Info修改已经注册用户的一些信息F_006用户注册Registration用户向站点注册F_007资源评论Resource Evaluation注册用户对资源进行评论F_008资源搜索Search Resource通过输入关键字搜索该资源站点中的资源F_009高级资源检索Advanced Search通过组合的条件来精确检索该资源站点中的资源F_010查看资源视图View Resource Category Tree通过系统提供的几种方式来进行查看该资源
17、站点中的资源视图，用来加速资源的浏览F_011查看资源视图中的资源列表View Resource List in a Selected Category当选定该资源站点中具体某一个资源视图以后，可以查看该资源视图下的所有资源，提供分页方式F_012查看资源View Resource通过下载查看该资源站点中的资源，包括查看资源的属性信息和资源内容F_013查看个人浏览资源历史Browsing History查看个人浏览资源的历史记录F_014用户收藏范围设置User Favorite Resource Category Setting用户设置自己感兴趣的资源的范围，将来可以用来过滤资源，可以定购
18、该范围内的资源。F_015站点书签浏览Web Site Bookmarks Browsing浏览站点书签F_016资源收藏管理User Favorite Management用户管理（添加、删除、修改）收藏的资源信息F_017下载站内资源Downloading in the Web Site下载站点内部的资源F_018查看资源的属性信息（资源元数据）View Resource Mata Data Info. Details查看资源的属性信息（资源元数据）基本系统中的后台维护F_019系统设置管理System Setting Management设置系统参数F_020永久资源存储单元管理Pers
19、istent Resource Storage Location Management管理放置永久资源的存储单元F_021上载资源存储单元管理Upload Resource Storage Location Management管理放置上载资源的存储单元F_022系统安全管理Privilege/Role/User Management 权限、角色、用户管理F_023资源提供商信息管理Resource Provider Info. Management对于资源提供商的信息、各种商业资源的信息进行管理F_024资源评论管理Resource Evaluation Management资源审核员对用户
20、给资源的评论进行管理，可以进行置顶、删除等操作。F_025资源专家评论Resource Evaluation by Expert资源审核员可以对资源进行专家评论F_026审核资源Validate Uploaded Resource对于用户上载的资源，审核员对资源进行审核，并把通过审核的资源关联到适当的资源视图。F_027地区用户管理Area User Management地区管理员可以对该授权地区内的用户进行管理扩展系统中的前台应用F_028分布式系统中的资源浏览Browsing Distributed Resource Mata Data Info(Extend System)依旧包含了查看
21、资源视图、查看资源视图中的资源列表、查看资源等功能模块，但是对基本系统中的资源浏览进行了扩充F_029分布式系统中的查看资源视图View Distributed Resource Category Tree (Extend System)扩充了基本系统中查看资源视图的功能，如果该站点是资源中心，那么能够查看整个资源网中的资源视图F_030分布式系统中的查看资源视图中的资源列表View Distributed Resource List in a Selected Category(Extend System)扩充了基本系统中查看资源视图中的资源列表的功能，如果该站点是资源中心，那么可以查看该资
22、源视图下的整个资源网中的资源列表F_031分布式系统中的下载资源Downloading across Web Sites(Extend System)扩充了基本系统中下载资源的功能，能够跨资源站点下载资源F_032分布式系统中的资源检索Search Distributed Resource扩充了基本系统中资源搜索功能，能够搜索整个资源网中的所有资源F_033分布式系统中的高级检索Advanced Distributed Search扩充了基本系统中的高级搜索功能，能够通过组合条件精确搜索整个资源网中的所有资源扩展系统中的后台维护F_034资源导入Resource Batch Import批量导
23、入符合标准的海量资源到本地资源站点F_035资源导出Resource Batch Export将本地海量资源导出为符合标准的格式F_036资源站点注册与注销Web Site Registration / Un-registration在站点注册中心注册/修改/注销某个资源站点的信息F_037资源同步Resource Mata Data Synchronization将某个/某些资源站点的资源属性信息同步到资源中心F_038站点书签同步Web Site Bookmarks Synchronization将某个/某些资源站点的站点书签信息同步到资源中心F_039资源订阅Mailing New Re
24、source Subscription 系统将系统新增的资源按照用户设置给用户发送新增资源列表F_040网络资源搜索Internet Searching定时监视某些指定的Internet站点，将其最新的教育教学方面的信息采集到资源站点中2.5功能需求与程序的关系批量导入程序 ResImporter.jar run.bat(Windows) run.sh (AIX,LINUX)批量导出程序ResExporter.exe标准转换程序 RDF2XML.exe资源同步客户端ResSyn.exe/ResSyn.jar资源站点服务程序ResApps.ear内含n ResourceInventoryEJBs
25、.jarn AllSessionBeans.jarn ResSynWeb.warn ResUddi.warn WebPrjs.war2.6人工处理过程2.7尚未问决的问题3接口设计3.1用户接口3.2外部接口（1）同步接口(通过输出为Web Service接口)public static long getAllResCount(StringstrUser, StringstrPasswd, StringstrReqIp)取得某个资源站点的所有有效资源数目，传入参数为用户名,密码和请求者的ip public static String getAllResSepGuid(StringstrUser
26、, StringstrPasswd, longlngBlockCount, StringstrReqIp)所有资源的guid要分多次返回,返回的数组为分次返回的间隔条件,数组的大小与传入的参数大小相同,表示要分多少次返回，由于我们认为最小值为空” ”,所以传回的数组为第一个间隔到最大值，也就是说不包括” ” public static String getAllResBlockGuid(StringstrUser, StringstrPasswd, StringstrStartGuid, StringstrEndGuid, StringstrReqIp)取得某个区间的所有资源的guid,传入参
27、数表示范围,返回的guid需要大于startguid,需要小于或者等于endguid public static long getUpdateResCount(StringstrUser, StringstrPasswd, StringstrLastUpdateTime, StringstrCurUpdateTime, StringstrReqIp)取得需要修改的资源数目,需要传入上次更新的时间,由于两台机器的系统时间不同,所以也需要传入更新截至时间,该时间用作下次参数的上次更新时间,资源站点返回的是在这段时间内修改的资源纪录,等于这两个时间也满足条件 public static String
28、 getUpdateResSepGuid(StringstrUser, StringstrPasswd, longlngBlockCount, StringstrLastUpdateTime, StringstrCurUpdateTime, StringstrReqIp)分次返回需要修改的资源的guid的分割字符串, 与getAllResSepGuid类似public static String getUpdateResBlockGuid(StringstrUser, StringstrPasswd, StringstrStartGuid, StringstrEndGuid, Stringst
29、rLastUpdateTime, StringstrCurUpdateTime, StringstrReqIp)返回某个区间内资源的guidpublic static Element getResItemElement(StringstrUser, StringstrPasswd, StringstrResGuid, StringstrReqIp)返回某个资源的所有属性public static byte getResContent(StringstrUser, StringstrPasswd, StringstrResGuid, StringstrReqIp)返回某个资源的文件内容，该接口是
30、可选的，资源站点可以根据自己的情况是否实现 public static long getDelResCount(StringstrUser, StringstrPasswd, StringstrLastUpdateTime, StringstrCurUpdateTime, StringstrReqIp)取得需要删除的资源数目,需要传入上次更新的时间,由于两台机器的系统时间不同,所以也需要传入更新截至时间,该时间用作下次参数的上次更新时间,资源站点返回的是在这段 时间内修改的资源纪录,等于这两个时间也满足条件 public static String getDelResSepGuid(Strin
31、gstrUser, StringstrPasswd, longlngBlockCount, StringstrLastUpdateTime, StringstrCurUpdateTime, StringstrReqIp)返回需要删除的资源的guid的分割字符串 public static String getDelResBlockGuid(StringstrUser, StringstrPasswd, StringstrStartGuid, StringstrEndGuid, StringstrLastUpdateTime, StringstrCurUpdateTime, StringstrR
32、eqIp)返回某个区间内需要删除的资源的guid （2）异构资源互换接口(a）RDF格式资源接口RDF格式资源，即符合基础教育教学资源元数据规范要求的资源属性描述文件，现在已知的支持该格式的资源提供商有国之源公司。格式如下：国之源兵蚁和蚁后file10001000215304113.JPG以白蚁为例讲述昆虫纲的主要特征或讲述动物的社群行为。ZH媒体素材-图形（图像）类素材商业收费基础教育教学元数据规范(BERMS)ZH0image/jpeg2002-3-21 18:15:35动物的行为社群行为昆虫昆虫纲节肢动物门自然科学-生物-动物的运动和行为-动物的行为-动物行为的类型北京国之源软件技术有限公司学生教师初中教育普通中等教育7年级8年级9年级普通中等教育-自然科学-生物-动物的运动和行为-动物的行为-动物行为的类型103814N已审核Pict022.JPG上述格式中粗体字为国之源公司对该格式的扩展部分。我们需要能够解析这样格式的资源元数据，能够通过某种途径将这种属性描述格式的资源导入到我们的资源站点中。(b) XML格式资源接口该格式是北京校际通技术责任有限公司根据教育部资源建设xxx规范，自己制定的资源元数据标注格式。该XML格式的DTD定义为：!ELEMENT dirtypename (