移动通信公司知识管理系统详细设计.doc

移动通信公司移动通信公司 知识管理系统知识管理系统 详细设计文档详细设计文档 移动通信公司移动通信公司 移动公司知识管理系统 移动通信ii 知识管理系统知识管理系统 详细设计文档详细设计文档 2010 年年 12 月月 移动公司知识管理系统 移动通信iii 文档信息文档信息 文档名称文档名称 作作 者者 类类 别别 子子 类类 别别 文件名称文件名称 摘摘 要要 修订历史修订历史 (REVISION HISTORY) 版本号版本号日期日期修改人修改人审阅人审阅人摘摘 要要 移动公司知识管理系统 移动通信公司I 目目 录录 详细设计文档详细设计文档 .I 1前言前言.4 1.1适用对象.4 1.2参考文档.4 2SSO.5 2.1设计概述.5 2.1.1单点登录（SSO）简介.5 2.1.2SSO 需求描述.5 2.1.3方案描述.7 2.2类设计.10 2.2.1cmcc.vg.km.sso.client .10 2.2.2cmcc.vg.km.sso.server .13 2.2.3cmcc.vg.km.sso.server.registry.17 2.3交互关系图.19 2.3.1获取令牌.19 2.3.2验证令牌.20 2.3.3注销.22 2.3.4重定向到 Quickplace.23 2.4数据库设计.25 2.5LDAP 设计 .26 2.5.1员工.27 2.5.2用户组.28 2.5.3组织.28 2.5.4用户 id 命名方式.28 2.6接口说明.29 2.6.1HTTP 接口.29 2.6.2接口 Java API 说明 .30 2.6.3外部系统改造建议方案.32 2.6.4内部子系统改造建议方案.33 2.7配置说明.34 3PORTAL”隔开，每个分类的定义如下：父分类序号:本分类 序号:分类名称。本类可以用在页面中分类目录和分类树的应用中。 输入定义输入定义 移动公司知识管理系统 移动通信公司56 56 #名称名称来源来源类型类型说明说明 1XPathPARA字符串分类XPATH 2strDBNamePara字符串要查询的索引库，库与库之间用逗号分开 处理流程处理流程 1.类初始化（创建IRMS_CONFIGSIMP.SimpleConfig对象 objCfg、IRMS_Categorizer.ExportChildrenXML对象exportChildrenXML、IRMS_Categorizer.Tree 对象objCagTree，利用objCfg的loadFile方法将龙卷风搜索引擎的配置文件IRMS.ini读入。 2.用objCagTree的方法GetData得到分类信息 3.利用ExportChildrenXML得到分类树的XML 4.遍历树节点，按父分类:本分类:分类名称的格式生成字符串。 5.遍历完成，返回生成的字符串。 输出定义输出定义 响应码响应码页面页面参数名参数名去向去向类型类型说明说明 字符串顶点分类的父分类 号为-1 空串错误 5.1.3排名页 页面流转 功能名称功能名称排名页使用角色使用角色登录用户 功能简述功能简述显示某一分类的当前排名前10名的文章。 功能的页面流程定义功能的页面流程定义 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 点击某一篇文章查看原文：链接到documentum查看原文；调用 隐藏页隐藏页程序修改本文档的点击次数。 流程设计 类名称类名称 Km.cat.DocHitNumber.getTop10Doc() 参考页面参考页面 功能简述功能简述根据用户输入的分类和排名种类，返回排名前10名的文档标题。 输入定义输入定义 #名称名称来源来源类型类型说明说明 1strCategoryPARA字符串分类 2intDatPara整数1表示当天，2表示本周，3表示本月 移动公司知识管理系统 移动通信公司57 57 处理流程处理流程 1.连接数据库 2.返回前10名的标题和ID 输出定义输出定义 响应码响应码页面页面参数名参数名去向去向类型类型说明说明 ResultSet数据库ResultSet 空串错误 5.1.4最新文章页 页面流转 功能名称功能名称最新文章页使用角色使用角色 功能简述功能简述以列表的方式显示某一分类的最新文章（6条） 功能的页面流程定义功能的页面流程定义 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 1点击链接弹出新页，查看原文：链接到documentum查看 原文。 流程设计 类名称类名称 km.cat.DataSearch 参考页面参考页面 功能简述功能简述利用龙卷风的搜索引擎，将设置条件组合在一起，返回所需结果。输出结果：龙 卷风的Result对象，无结果时此对象为空。 输入定义输入定义 #名称名称来源来源类型类型说明说明 1SPARA字符串索引库 2PPara字符串关键字 3LctPara字符串分类 4VPara整型高级查询开关（以下参数是高级查询才有的） 5APara字符串每页显示行数 6OPara字符串排序字段 7OaPara字符串排序顺序 移动公司知识管理系统 移动通信公司58 58 8FPara字符串模糊搜索 9LPara字符串同义词搜索 10TitlePara字符串标题 11FilenamePara字符串文件名 12FiletypePara字符串文件类型 13Filedate1Para字符串文件开始日期 14Filefate2Para字符串文件结束日期 15AuthorPara字符串作者 16FilesizePara字符串文件长度 处理流程处理流程 1.创建龙卷风Command对象objCmd 2.设置索引库（objCmd.SetOption(1,索引库列表)）索引库之间用逗号“,”隔开 3.设置模糊查询（objCmd.SetOption(4,1)） 4.设置同义词库查询（objCmd.SetOption(4,2)） 5.设置排序字段（objCmd.SetOption(5,排序字段名称)）-可选 6.设置排序方式（objCmd.SetOption(6,排序方式)）-可选 7.设置关键字（objCmd.SetOption(0,关键字)）-可选 8.生成FieldDesc对象vField，FDExpression对象vFDE，字符串strFDE 9.设置标题条件：置vField对象的fileName属性为”TITLE”，OP属性为 .3fiyupluginfiyuforumuserheader.jsp 1) 修改背景图片； 2) 屏蔽短信提示； 3) 屏蔽“注册新使用者”，去掉“短信中心”，加上“知识订阅”。 4) 去掉主页、特色、论坛截图、下载、交流、搜索等功能部分。 .4fiyupluginfiyuforumuserfooter.jsp 文件内容修改为： .5其它修改 去掉所有文件中的： 移动公司知识管理系统 移动通信公司79 79 6.1.2精华和顶固功能 DB 修改 .1Thread 表 使用 ThreadOption 字段表示精华：0 表示普通，1 表示精华。 使用 ThreadStatus 字段表示顶固：0 表示普通，1 表示顶固。 CLASS修改 .1fiyuforum.auth. fiyuForumPermission 添加以下代码： /* * 设置精华 */ public static final int PERMISSION_SET_ELITE = 2110; /* * 设置顶固 */ public static final int PERMISSION_SET_TOP = 2111; public boolean canSetElite(int forumID); public void ensureCanSetElite(int forumID) throws AuthenticationException; public boolean canSetTop(int forumID); public void ensureCanSetTop(int forumID) throws AuthenticationException; .2fiyuforum.auth. AbstractPermission .2.1public static final int globalIndividualPermissionArray 添加以下代码： PERMISSION_SET_ELITE, PERMISSION_SET_TOP 移动公司知识管理系统 移动通信公司80 80 .2.2public static final int forumIndividualPermissionArray 添加以下代码： PERMISSION_SET_ELITE, PERMISSION_SET_TOP .2.3public static String getDescription(int permission) 添加以下代码： case PERMISSION_SET_ELITE: desc = 设置精华; break; case PERMISSION_SET_TOP: desc = 设置顶固; break; .2.4其它修改 增加以下代码： protected ForumListPermission setElite = new ForumListPermission(); protected ForumListPermission setTop = new ForumListPermission(); public boolean canSetElite(int forumID) return setElite.hasPermssion(forumID); public void ensureCanSetElite(int forumID) throws AuthenticationException if (canSetElite(forumID) = false) throw new AuthenticationException(NotLoginException.NOT_ENOUGH_RIGHTS); public boolean canSetTop(int forumID) return setTop.hasPermssion(forumID); public void ensureCanSetTop(int forumID) throws AuthenticationException 移动公司知识管理系统 移动通信公司81 81 if (canSetTop(forumID) = false) throw new AuthenticationException(NotLoginException.NOT_ENOUGH_RIGHTS); .3fiyuforum.auth. fiyuForumPermission .3.1void setPermission(int permission) 1)在 PERMISSION_SYSTEM_ADMIN 和 PERMISSION_FORUM_ADMIN，PERMISSION_FORUM_MODERATOR 下添加以 下代码： /* setElite.setAllForumsPermission(true); setTop.setAllForumsPermission(true); 2)添加以下代码： case PERMISSION_SET_ELITE: setElite.setAllForumsPermission(true); break; case PERMISSION_SET_TOP: setTop.setAllForumsPermission(true); break; .3.2void setPermissionInForum 1)在 PERMISSION_FORUM_ADMIN，PERMISSION_FORUM_MODERATOR 下添加以下代码： /* setElite.setForumPermission(forumID, true); setTop.setForumPermission(forumID, true); 2)添加以下代码： case PERMISSION_SET_ELITE: setElite.setForumPermission(forumID, true); break; case PERMISSION_SET_TOP: setTop.setForumPermission(forumID, true); 移动公司知识管理系统 移动通信公司82 82 break; .4fiyuforum.user. UserModuleProcessor 添加以下代码： else if (requestURI.equals(/setelite) threadWebHandler.prepareSetElite(request); else if (requestURI.equals(/seteliteprocess) threadWebHcessSetElite(request); else if (requestURI.equals(/settop) threadWebHandler.prepareSetTop(request); else if (requestURI.equals(/settopprocess) threadWebHcessSetTop(request); .5fiyuforum.user. UserModuleURLMapHandler 添加以下代码： else if (requestURI.equals(/settop) map.setResponse(/fiyuplugin/fiyuforum/user + localeName + /settop.jsp); else if (requestURI.equals(/settopprocess) map.setResponse(/fiyuplugin/fiyuforum/user + localeName + /settopsuccess.jsp); else if (requestURI.equals(/setelite) map.setResponse(/fiyuplugin/fiyuforum/user + localeName + /setelite.jsp); else if (requestURI.equals(/seteliteprocess) map.setResponse(/fiyuplugin/fiyuforum/user + localeName + /setelitesuccess.jsp); .6fiyuforum.user. ActionInUserModule 添加以下代码： if (requestURI.equals(/settopprocess) 移动公司知识管理系统 移动通信公司83 83 desc = 刚刚把帖子固定到顶部 N/A; else if (requestURI.equals(/setelite) desc = 正在管理论坛 N/A; .7fiyuforum.user. ThreadWebHandler 添加以下代码： void prepareSetTop(HttpServletRequest request) throws BadInputException, ObjectNotFoundException, DatabaseException, AuthenticationException, AssertionException OnlineUser onlineUser = onlineUserManager.getOnlineUser(request); fiyuForumPermission permission = onlineUser.getPermission(); int threadID = ParamUtil.getParameterInt(request, thread); ThreadBean threadBean = ThreadWebHelper.getThread(threadID); permission.ensureCanSetTop(threadBean.getForumID(); Collection forumBeans = ForumCache.getInstance().getBeans(); int numberOfPosts = PostWebHelper.getNumberOfPosts_inThread(threadID); request.setAttribute(ThreadBean, threadBean); request.setAttribute(ForumBeans, forumBeans); request.setAttribute(NumberOfPosts, new Integer(numberOfPosts); void processSetTop(HttpServletRequest request) throws BadInputException, ObjectNotFoundException, DatabaseException, ForeignKeyNotFoundException, AuthenticationException, AssertionException OnlineUser onlineUser = onlineUserManager.getOnlineUser(request); fiyuForumPermission permission = onlineUser.getPermission(); permission.ensureIsAuthenticated(); int threadID = ParamUtil.getParameterInt(request, thread); ThreadBean threadBean = ThreadWebHelper.getThread(threadID); int forumID = threadBean.getForumID(); 移动公司知识管理系统 移动通信公司84 84 int threadStatus = 1 - threadBean.getThreadStatus(); permission.ensureCanSetTop(forumID); try String memberPassword = ParamUtil.getParameterPassword(request, MemberMatkhau, 3, 0); ManagerFactory.getOnlineUserFactory().validatePassword(onlineUser.g etMemberName(),memberPassword, false); catch (AuthenticationException e) throw new BadInputException(输入的密码不正确，不能继续！); ThreadWebHelper.updateThread_Status(threadID, threadStatus); /PostWebHelper.updatePost_ForumID_inThread(threadID, destForumID); /FavoriteThreadWebHelper.updateFavoriteThread_ForumID_inThread(thread ID, destForumID); PostIndexer.scheduleUpdateThreadTask(threadID); request.setAttribute(ForumID, String.valueOf(forumID); void prepareSetElite(HttpServletRequest request) throws BadInputException, ObjectNotFoundException, DatabaseException, AuthenticationException, AssertionException OnlineUser onlineUser = onlineUserManager.getOnlineUser(request); fiyuForumPermission permission = onlineUser.getPermission(); int threadID = ParamUtil.getParameterInt(request, thread); ThreadBean threadBean = ThreadWebHelper.getThread(threadID); permission.ensureCanSetElite(threadBean.getForumID(); Collection forumBeans = ForumCache.getInstance().getBeans(); int numberOfPosts = PostWebHelper.getNumberOfPosts_inThread(threadID); request.setAttribute(ThreadBean, threadBean); request.setAttribute(ForumBeans, forumBeans); request.setAttribute(NumberOfPosts, new Integer(numberOfPosts); 移动公司知识管理系统 移动通信公司85 85 void processSetElite(HttpServletRequest request) throws BadInputException, ObjectNotFoundException, DatabaseException, ForeignKeyNotFoundException, AuthenticationException, AssertionException OnlineUser onlineUser = onlineUserManager.getOnlineUser(request); fiyuForumPermission permission = onlineUser.getPermission(); permission.ensureIsAuthenticated(); int threadID = ParamUtil.getParameterInt(request, thread); ThreadBean threadBean = ThreadWebHelper.getThread(threadID); int forumID = threadBean.getForumID(); int threadOption = 1 - threadBean.getThreadOption(); permission.ensureCanSetElite(forumID); try String memberPassword = ParamUtil.getParameterPassword(request, MemberMatkhau, 3, 0); ManagerFactory.getOnlineUserFactory().validatePassword(onlineUser.getMem berName(), memberPassword, false); catch (AuthenticationException e) throw new BadInputException(输入的密码不正确，不能继续！); ThreadWebHelper.updateThread_Option(threadID, threadOption); /PostWebHelper.updatePost_ForumID_inThread(threadID, destForumID); /FavoriteThreadWebHelper.updateFavoriteThread_ForumID_inThread(thread ID, destForumID); PostIndexer.scheduleUpdateThreadTask(threadID); request.setAttribute(ForumID, String.valueOf(forumID); 移动公司知识管理系统 移动通信公司86 86 JSP 修改 .1fiyupluginfiyuforumuserlistthreads.jsp 添加以下代码： 固 .2fiyupluginfiyuforumuser setelite.jsp 新增 .3fiyupluginfiyuforumusersetelitesuccess.jsp 新增 .4fiyupluginfiyuforumuser settop.jsp 新增 .5fiyupluginfiyuforumuser settopsuccess.jsp 新增 6.1.3积分功能 积分规则维护 积分增减 积分查询 6.1.4屏蔽了的功能 用户界面 .1用户注册 统一管理用户 .2短信中心 不需要 移动公司知识管理系统 移动通信公司88 88 .3导出 XML 不需要 管理界面 .1系统信息检测 不需要 .2其它管理任务 不需要 6.2 博客 个人博客由工作日志和个人专辑以及文章查询三部分组成，工作日志可以 看作是一个固定的专辑，而专辑和论坛的差别也只是表现在权限的控制上 而已，因此博客完全可以用论坛来实现，它是论坛的一种特殊表现形式。 6.2.1工作日志 维护日志 .1界面流转 功能名称功能名称维护日志使用角色使用角色所有用户 功能简述功能简述用户填写（如果当天没有的话）或修改指定日期的日志，默认当前日期 功能的页面流程定义功能的页面流程定义 填写日志 P.1 提交请求处理结果页面 P.2 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 1P.0指定日期，选择“本日日 志”链接 查询该用户指定日期的日志 2P.1修改或维护日志提交日志内容，处理用户提交的请求 3P.2处理用户提交的请求，显示处理结果 移动公司知识管理系统 移动通信公司89 89 .2流程定义 1)查询查询 参见下文“查询日志”部分，开始和截止日期设为同一日期。 2)处理处理 类名称类名称 com.lclg.km.blog.worklog.doLog 参考页面参考页面 功能简述功能简述处理用户提交的日志 输入定义输入定义 #名称名称来源来源类型类型说明说明 1userIDSESSION数值用户编号 2logDatePARA字符串指定日期(YYYY-MM-DD) 3logBodyPARA字符串日志内容 处理流程处理流程 1.根据日志是否存在调用fiyuform.user.ThreadWebHelper的createThread方法或 updateThreadTopic_Body方法。 2.若处理成功，则返回日志流水号，若失败，则返回错误信息 输出定义输出定义 响应码响应码页面页面参数名参数名去向去向类型类型说明说明 P.2threadID数值日志流水号 fatalerror.jspfatal_error_message字符串对不起，程序出现意 外错 误：fatal_error_mes sage 查询日志 .1界面流转 功能名称功能名称维护日志使用角色使用角色所有用户 功能简述功能简述用户填写（如果当天没有的话）或修改指定日期的日志，默认当前日期 功能的页面流程定义功能的页面流程定义 查询结果页面 P.1 提交请求 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 1P.0指定时间段，选择查询日 志链接 查询该用户指定时间段内的日志 2P.1显示处理结果 移动公司知识管理系统 移动通信公司90 90 .2流程定义 类名称类名称 com.lclg.km.blog.worklog.queryLog 参考页面参考页面 功能简述功能简述根据用户输入日期，查询日志内容 输入定义输入定义 #名称名称来源来源类型类型说明说明 1userIDPARA数值用户编号 2startDatePARA字符串指定开始日期(YYYY-MM-DD) 3endDatePARA字符串指定截止日期(YYYY-MM-DD) 处理流程处理流程 1.创建fiyuform.user.ThreadWebHandler实例，根据指定用户和时间段查询数据。 2.若加载成功，则返回包含ThreadBean实例的List，若失败，则返回错误信息 输出定义输出定义 响应响应 码码 页面页面参数名参数名去向去向类型类型说明说明 P.1logListList包含如果存在记录则为包 含 fiyuforum.db.ThreadBean 的List，否则为NULL fatalerror.jspfatal_error_message字符串对不起，程序出现意外错 误：fatal_error_message 6.2.2个人专辑 新增专辑 .1界面流转 功能名称功能名称新增专辑使用角色使用角色所有用户 功能简述功能简述用户新增一个自己的文章专辑 功能的页面流程定义功能的页面流程定义 填写专辑信息 P.1 提交请求处理结果页面 P.2 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 1P.0选择“新增专辑”链接查询用户信息 2P.1填写专辑信息处理用户提交的请求，将结果返回到结果页面 3P.2显示处理结果 移动公司知识管理系统 移动通信公司91 91 .2流程定义 类名称类名称 com.lclg.km.blog.cate.addCate 参考页面参考页面 功能简述功能简述新增用户的文章专辑 输入定义输入定义 #名称名称来源来源类型类型说明说明 1userIDSESSION数值用户编号 2cateTitlePARA字符串 3cateStatusPARA数值 处理流程处理流程 1.调用fiyuform.admin. ForumWebHandler的processAdd方法处理请求。 2.若处理成功，则返回专辑名称，若失败，则返回错误信息 输出定义输出定义 响应码响应码页面页面参数名参数名去向去向类型类型说明说明 P.2ForumName字符串 fatalerror.jspfatal_error_message字符串对不起，程序出现意 外错 误：fatal_error_mes sage 修改专辑 .1界面流转 功能名称功能名称修改专辑使用角色使用角色所有用户 功能简述功能简述修改指定专辑的信息 功能的页面流程定义功能的页面流程定义 修改专辑信息 P.1 提交请求处理结果页面 P.2 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 1P.0选择修改专辑链接查询专辑信息 2P.1修改专辑信息处理用户提交的请求，将结果返回到结果页面 3P.2显示处理结果 .2流程定义 类名称类名称 com.lclg.km.blog.cate.editCate 参考页面参考页面 功能简述功能简述修改用户指定的专辑信息 输入定义输入定义 移动公司知识管理系统 移动通信公司92 92 #名称名称来源来源类型类型说明说明 1userIDSESSION数值用户编号 2cateIDPARA数值 3cateTitlePARA字符串 4cateStatu s PARA数值 处理流程处理流程 1.调用fiyuform.admin. ForumWebHandler的processUpdate方法处理请求。 2.若处理成功，则返回专辑名称，若失败，则返回错误信息 输出定义输出定义 响应响应 码码 页面页面参数名参数名去向去向类型类型说明说明 P.2ForumName字符串 fatalerror.jspfatal_error_message字符串对不起，程序出现意外 错 误：fatal_error_messag e 清空专辑 .1界面流转 功能名称功能名称清空专辑使用角色使用角色所有用户 功能简述功能简述清空指定专辑下的所有文章 功能的页面流程定义功能的页面流程定义 处理结果页面 P.1 提交请求 步骤步骤页面编号页面编号用户操作用户操作系统处理系统处理 1P.0选择清空专辑链接查询专辑信息 2P.1处理用户提交的请求，显示处理结果 .2流程定义 类名称类名称 com.lclg.km.blog.cate.clearCate 参考页面参考页面 功能简述功能简述清空指定专辑下的所有文章 输入定义输入定义 #名称名称来源来源类型类型说明说明 1userIDSESSION数值用户编号 2cateIDPARA数值 处理流程处理流程 移动公司知识管理系统 移动通信公司93 93 1.调用fiyuform.admin. ForumWebHandler的processClear方法处理请求。 2.若处理成功，则返回专辑名称，若失败，则返回错误信息 输出定义输出定义 响应响应 码码 页面页面参数名参数名去向去向类型类型说明说明 P.1ForumName字符串 fatalerror.jspfatal_error_message字符串对不起，程序出现意外 错 误：fatal_error_messag e 删除专辑 .1界面流转 功能名称功能名称删除专辑使用角色使用角色所有用户 功能