用户及资源权限管理设计.doc

. 精选范本 通用用户管理和权限控制系统通用用户管理和权限控制系统 软件设计文档软件设计文档 版本版本 1.0 . 精选范本 修订历史记录修订历史记录 日期日期版本版本说明说明作者作者 2003/5/121.0创建JavaOA 项目组 . 精选范本 目录目录 1.简介简介.5 1.1目的.5 1.2范围.5 1.3定义、首字母缩写词和缩略语.5 1.4参考资料.5 1.5概述.6 2.构架表示方式构架表示方式.6 3.构架目标和约束构架目标和约束.6 3.1约束.6 3.2目标.6 4.构架机制构架机制.7 4.1分析机制.7 4.2分析机制-设计机制-实现机制映射.7 5.用例视图用例视图.7 5.1视图.7 5.2用例(USE CASE).8 5.3操作员（ACTOR）.9 6.类包图类包图.9 6.1概述.9 6.2在构架方面具有重要意义的设计包.10 6.2.1接口（interface）.10 6.2.2基础管理（BasicManage）.11 6.2.2.1组织机构类（department）.12 6.2.2.2组织机构管理类.12 6.2.2.3用户管理类（UserManager） .13 6.2.2.4用户类（user）.14 6.2.2.5角色管理类（RoleManager） .15 6.2.2.6角色类（role）.16 6.2.2.7资源管理类（ResourceManager）.17 6.2.2.8资源类（Resource）.17 6.2.2.9权限管理类（PermissionManager）.18 6.2.2.10权限类（permission）.19 6.2.2.11用户组管理类.20 6.2.2.12用户组类（group） .20 6.2.2.13授权管理类（GrantManager） .21 6.2.2.14用户角色类（user_role）.22 6.2.2.15用户组成员类（UserGroupMember） .22 6.2.2.16角色资源权限类（role_resource_permission） .23 6.2.3访问控制（AccessControl）.24 6.2.3.1会话控制类（SessinControler）.24 6.2.4日志记录（LogRec）.25 6.2.4.1日志类（log）.25 6.2.4.2日志管理类（LogManager）.26 . 精选范本 6.2.5底层支持(support).27 6.2.5.1数据库连接管理类（DatabaseConnectionControler）.27 6.2.5.2LDAP 系统连接管理类（LdapSystemConnectionControler）.28 6.2.5.3CA 系统连接管理类（CASystemConnectionControler）.28 6.2.5.4系统设置类.29 6.3设计与需求对应关系.30 6.3.1设计功能类与功能需求对应关系.30 6.3.2设计接口类与接口需求对应关系.30 7.组件视图组件视图.31 8.部署视图部署视图.32 8.1视图.32 9.数据视图数据视图.33 10.交互视图交互视图.34 10.1顺序视图.34 10.1.1添加一类权限：add a permission.34 10.1.2添加一项资源：add a resource.35 10.1.3添加一个角色：add a role.36 10.1.4添加一个用户：add a user.37 10.1.5系统管理员登录：administrator login.38 10.1.6将某资源的一项访问权限授权给某角色：grant a resources access permission to a role.39 10.1.7用户登录验证：login authenticate.40 10.1.8访问日志自动记录：record access log .41 10.1.9资源访问验证：resource access authenticate .42 10.1.10日志归档：archive log .43 10.1.11日志恢复：restore log.44 10.1.12删除日志：delete log.45 10.1.13添加公共用户组：add a public group.46 10.1.14添加一个用户自定义组：add a users self_defined group .47 10.1.15给公共用户组添加成员：add a member to public group.48 11.质量质量.49 11.1可重用性.49 . 精选范本 软件设计文档软件设计文档 1.1. 简介简介 1.11.1目的目的 本文档将从构架和详细设计两方面对通用用户管理和权限控制系统进行综合概述，其中会 使用多种不同的构架视图：用例视图、顺序图、协作图、类图、组件图等来描述系统的各个方 面，以作为下步编码测试的重要依据。 本文档的读者为：公司技术负责人、用户代表、项目经理、设计员、程序员、测试员、评 审组成员。 1.21.2范围范围 本文档将在通用用户管理和权限控制系统的设计和构建阶段适用，对它的修改将直接影 响系统的编码测试和系统构建。 本文档作为通用用户管理和权限控制系统开发过程中设计阶段的输出工件，既从系统整 体的架构设计的角度做决定，又包括系统的详细设计。 1.31.3定义、首字母缩写词和缩略语定义、首字母缩写词和缩略语 1.41.4参考资料参考资料 资料名称作者译者出版社出版时间书号 通用用户管理和权限控制系统项目 开发计划 Java OA2 项目组 无无2003 年 4 月 通用用户管理和权限控制系统需求 规格说明书 Java OA2 项目组 无无2003 年 5 月 . 精选范本 1.51.5概述概述 本文档将从十一个方面对通用用户管理和权限控制系统做出设计规定：简介、构架表示方式、 构架目标和约束、用例视图、逻辑视图、组件视图、部署视图、数据视图、交互图、质量。 2.2. 构架表示方式构架表示方式 通用用户管理和权限控制系统将采用当前流行的 J2EE 架构体系来设计构建，系统构架采用遵 照 UML 标准的面向对象建模工具 RATIONAL ROSE 来表示，将从用例视图、逻辑视图、组件视图、 部署视图这几个不同角度来展示系统。 用例视图用例视图：描述系统的功能（use cases）、外部环境（actors）、use case 和 actors 之 间的关系（use case diagram）。 逻辑视图逻辑视图：主要包括交互图（interaction diagram）、类图（class diagram）。交互图又 分时序图（sequence diagram）和协作图（collaboration diagram）. 时序图按时间显示信息流； 协作图显示对象间的关系和消息；类图显示系统的包和类，显示系统组件及其相互间关系。在架 构设计阶段，最有用的是类图，在本系统架构设计文档中，我们也只列出系统类图。 组件视图组件视图：描述系统的实际结构，展示系统组件如何构成代码库并显示组件间的关系（依赖 性关系）。 部署视图部署视图：描述各组件在物理上的位置关系，展示系统运行时软硬件的实际部署情况。 3.3. 构架目标和约束构架目标和约束 根据通用用户管理和权限控制系统需求规格说明书的规定，本系统在架构方面有一定的目 标和约束条件。 3.13.1约束约束 必须基于 JAVA 架构体系 3.23.2目标目标 本系统构架将实现如下目标： 重用：重用：为了避免重复劳动，为了降低成本，我们希望能够在以后的开发中重用本系统的代 码和设计。 透明：透明：为了提高效率，我们将把实现的细节隐藏起来，仅把客户最终需求或二次开发需求 的接口呈现给客户或二次开发者。这样，具体的实现对客户和二次开发者来说就是透明的。 . 精选范本 延展：延展：由于需求的易变性。我们需要架构具有一定的延展性，以适应未来可能的变化。但 是，延展性和稳定性，延展性和简单性都是矛盾的。因此我们需要权衡我们的投入/产出 比。以设计出具有适当和延展性的架构。 简明：简明：一个复杂的架构不论是测试还是维护都是困难的。我们希望架构能够在满足目的的 情况下尽可能的简单明了。 高效：高效：作为要嵌入办公自动化系统中的重要子系统，我们的用户管理和访问控制系统的架 构必须是高效的。 安全：安全：安全是架构的一个很重要的方面。 4.4.构架机制构架机制 4.14.1分析机制分析机制 对在分析中使用到的分析机制进行阐述 分析机制分析机制描述描述 持久性机制需要保存下来以备下次重新使用的一种机制 错误报告机制需要对程序运行时发生的错误需要进行某种方式让用户知 道的机制 安全性机制需要用一种方法保证非授权者不能使用或查看到信息的一 种机制 4.24.2分析机制分析机制- -设计机制设计机制- -实现机制映射实现机制映射 分析机制分析机制设计机制设计机制实现机制实现机制 带删除标记的文件保存机制带删除标记的 Java 序列化 机制持久性机制 数据保存机制数据库机制 错误报告机制窗口弹出错误信息机制Java 的错误报告机制 操作日志机制系统自动记录所有操作安全性机制 登录机制登录机制 5.5. 用例视图用例视图 5.15.1视图视图 系统用例视图如图 5.1，要说明的是考虑视图的篇幅，图中用例之间的关系都没有标明类 型，它们都应该为包含关系。 . 精选范本 # # # d l 5.25.2用例用例(use(use case)case) 根据上节视图，本系统共 12 个关键用例： 组织机构管理（department admin） 资源管理（resource admin） 角色管理（role admin） 权限管理（permission admin） 授权管理（grant resources permission to role） 用户管理（user admin） 日志管理（log admin） 日志查询（query log） 图 5.1 . 精选范本 登录控制（login control） 访问控制（access control） 日志记录（record log） 口令修改（passwd change） 5.35.3操作员（操作员（actoractor） 本系统共两类操作员：系统管理员和外部应用系统。 系统管理员利用系统提供的管理界面操作系统管理相关用例，主要是：组织机构管理、资源管 理、角色管理、权限管理、授权管理、用户管理、日志管理、日志查询。同时，系统管理员的一切行 为也需要通过系统的访问控制，也就是说这些管理用例要使用访问控制相关的后台用例：登录控制、 访问控制、日志记录、口令修改。 外部应用系统通过本系统提供的统一接口调用系统的访问控制相关用例：登录控制、访问控制、 日志记录、口令修改。 6.6. 类包图类包图 6.16.1概述概述 本系统可分为五个部分（如下图：6.1）：接口、基础管理、日志记录、访问控制、底层支持。 接口接口：包括为系统管理员提供的系统管理用户界面和为外部应用系统提供的调用接口。 基础管理基础管理：包括完成系统基础的管理功能（用户管理、资源管理、角色管理、权限管理、授权管 理、用户管理、日志管理、日志查询）的所有类。 日志记录日志记录：包括完成自动日志记录功能的类。 访问控制访问控制：包括实现统一登录验证、访问权限验证、会话管理的所有类。 底层支持底层支持：包括实现数据库连接或其它系统连接的所有类。 e e 图6.1 . 精选范本 6.26.2在构架方面具有重要意义的设计包在构架方面具有重要意义的设计包 6.2.1接口（interface） 系统主要包括 12 个接口，其中 8 个用户界面,四个外部调用接口： 登录页面（LoginPage） 主页（MainPage） 资源管理页面（ResourceInfoPage） 权限管理页面（PermissionInfoPage） 角色管理页面（RoleInfoPage） 角色授权页面（GrantManagePage） 用户管理页面（UserInfoPage） 日志管理页面（LogManagePage） 登录验证接口（LoginCheck） 资源访问验证接口（ResourceAccessCheck） 记录日志功能接口（RecordLog） 口令修改接口（PasswdChange） 图 6.2 . 精选范本 6.2.2基础管理（BasicManage） 图 63 . 精选范本 6.2.2.1组织机构类（department） 整整 体体 说说 明明 中文类名：中文类名：组织机构类 英文类名：英文类名：department 描述：描述：记录组织机构信息 一般类：一般类：无 主动性：主动性：NO 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明 机构编码 id 字符串12 位编码规则：机构分级，每 3 位一级，如 001 表示是一级机构；001002 表示 001 机 构下属的 002 机构；如此类推。 机构全称 description 字符串 50 机构简称 ShortName 字符串 20 属属 性性 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明操操 作作 说说 明明 6.2.2.2组织机构管理类 整整 体体 说说 明明 中文类名：中文类名：组织机构管理类 英文类名：英文类名：DepartmentManager 描述：描述：实现组织机构信息的增加、修改、删除、显示、查询 一般类：一般类：无 主动性：主动性：YES 其它：其它： 属属 性性 中文名中文名英文名英文名数据类数据类 型型 数据约束数据约束说明说明 . 精选范本 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明 增加部门 AddDepartment 修改部门 ModifyDepartmrntDepartmentId 删除部门 DeleteDepartmentDepartmentId 显示部门信息 ShowDepartmentDepartmentId Department 信息表格 操操 作作 说说 明明 搜索部门信息 SeekDepartmentDepartmentId Department 对象 6.2.2.3用户管理类（UserManager） 整整 体体 说说 明明 中文类名：中文类名：用户管理类 英文类名：英文类名：UserManager 描述：描述：管理用户信息，用户管理相关的所有操作都由它完成。 一般类：一般类：无 主动性：主动性：YES 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明属属 性性 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明 口令修改 UserPasswdChange 旧口令，新口令 加密口令 UserPasswdEncrypt 口令字符串加密串 解密口令 UserPasswdDecrypt 加密字符串解密后的口令 找回口令 UserPasswdFind 口令提示问题、问 题答案 解密后的口令 增加用户 AddUser 用户信息 操操 作作 说说 明明 修改用户信息 ModifyUserInfo 用户名、修改信息 . 精选范本 删除用户 DeleteUser 用户名 显示用户信息 ShowUserInfo 用户名 用户登录验证 UserAuthenticate 用户名、口令是否合法用户包括本系统、CA 系统、LDAP 系 统的验证 查询用户信息 SeekUserInfo 用户名 资源访问权限 验证 AccessAuthenticate 用户名、资源编码、 权限编码 是否有该资源 的此种权限 生成用户授权 视图 CreateGrantView 用户名生成某用户完整 的用户授权信息 视图，仅在当前 会话有效期存在 6.2.2.4用户类（user） 整整 体体 说说 明明 中文类名：中文类名：用户类 英文类名：英文类名：user 描述：描述： 记录用户基本信息 一般类：一般类：无 主动性：主动性：NO 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明 用户名 name 字符串 口令 passwd 字符串 提示问题 PasswdPromptQuestion 字符串 问题答案 PasswdQuestionResult 字符串 部门号 department 字符串 真实姓名 RealName 字符串 LDAP 用户名 LDAPUserName 字符串 属属 性性 说说 明明 LDAP 口令 LDAPUserPasswd 字符串 . 精选范本 CA 证书路径 CACertifyPath 字符串 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明操操 作作 说说 明明 6.2.2.5角色管理类（RoleManager） 整整 体体 说说 明明 中文类名：中文类名：角色管理类 英文类名：英文类名：RoleManager 描述：描述： 一般类：一般类：无 主动性：主动性：YES 其它：其它： 中文名中文名英文名英文名数据数据 类型类型 数据约束数据约束说明说明属属 性性 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明 增加角色 AddRole 角色信息 修改角色信息 Modifyrole 角色编码、修 改信息 删除角色 DeleteRole 角色编码 显示角色信息 ShowRoleInfo 角色编码 操操 作作 说说 明明 查询角色信息 SeekRole 角色编码 . 精选范本 6.2.2.6角色类（role） 整整 体体 说说 明明 中文类名：中文类名：角色类 英文类名：英文类名：role 描述：描述： 记录角色定义信息 一般类：一般类：无 主动性：主动性：NO 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明 角色编码 id 字符串 角色描述 description 字符串 角色名称 ShortName 字符串 属属 性性 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明操操 作作 说说 明明 6.2.2.7资源管理类（ResourceManager） 整整 体体 说说 明明 中文类名：中文类名：资源管理类 英文类名：英文类名：ResourceManager 描述：描述： 一般类：一般类：无 主动性：主动性：YES 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明属属 性性 说说 明明 . 精选范本 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明 增加资源 AddResource 资源信息 修改资源信息 ModifyResource 资源编码、 修改信息 删除资源 DeleteResource 资源编码 显示资源信息 ShowResourceInfo 资源编码 操操 作作 说说 明明 查询资源信息 SeekResource 资源编码 6.2.2.8资源类（Resource） 整整 体体 说说 明明 中文类名：中文类名：资源类 英文类名：英文类名：Resource 描述：描述： 一般类：一般类：无 主动性：主动性：NO 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明 资源编码 id 字符串编码规则：资源分级，每 3 位一级，如 001 表示是一级资源；001002 表示 001 资源下 属的 002 资源；如此类推。 资源描述 description 字符串 资源名称 ShortName 字符串 属属 性性 说说 明明 资源 URL URL 字符串由此定位资源 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明操操 作作 说说 明明 . 精选范本 6.2.2.9权限管理类（PermissionManager） 整整 体体 说说 明明 中文类名：中文类名：权限管理类 英文类名：英文类名：PermissionManager 描述：描述： 一般类：一般类：无 主动性：主动性：YES 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明属属 性性 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明 增加权限 AddPermission 权限信息 修改权限信息 ModifyPermission 权限编码、 修改信息 删除权限 DeletePermission 权限编码 显示权限信息 ShowPermissionInfo 权限编码 操操 作作 说说 明明 查询权限信息 SeekPermission 权限编码 6.2.2.10权限类（permission） 整整 体体 说说 明明 中文类名：中文类名：权限类 英文类名：英文类名：permission 描述：描述： 一般类：一般类：无 主动性：主动性：NO 其它：其它： 属属 性性 中文名中文名英文名英文名数据类数据类 型型 数据约束数据约束说明说明 . 精选范本 权限编码 id 字符串 权限描述 description 字符串 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明操操 作作 说说 明明 6.2.2.11用户组管理类 整整 体体 说说 明明 中文类名：中文类名：用户组管理类 英文类名：英文类名：GroupManager 描述：描述： 一般类：一般类：无 主动性：主动性：NO 其它：其它： 中文名中文名英文名英文名数据类型数据类型数据约束数据约束说明说明属属 性性 说说 明明 中文名中文名英文名英文名输入参数输入参数输出参数输出参数说明说明 添加用户组 AddGroup 删除用户组 DeleteGroup 该组成员同 时删除 添加组成员 AddGroupMember 删除组成员 DeleteGroupMember 操操 作作 说说 明明 . 精选范本 6.2.2.12用户组类（group） 整整 体体 说说 明明 中文类名：中文类名：用户组类 英文类名：英文类名：gro