<系统名称〉接口设计说明书
修改历史
目录
1概述
[概述说明本文档的描述的内容、目的、使用场合等。
]
2子系统说明1
2.1 接口名N0.1
示例如下:
接口功能:
验证用户是否合法。
除部分特别说明不需要用户验证的接口外,此接口必须首先调用,否则会出现“未授权” 的异常错误。
在验证成功之后才能成功调用其它接口,该接口验证通过的用户信息将保存到IHDUserSession类的实例中,作为其它接口调用的用户信息。
此接口在内部需要通过以下几点的验证:
1. CA验证,验证USBKey是否合法(只有系统策略中设置了需要CA验证选项后才会进
行CA的验证);
2. 域用户验证,验证登录用户名和密码是否是域用户,通过Windows集成身份验证实现;
3. 用户数据库合法性验证,验证登录用户是否存在于USERS表中;
4. 计算机合法性验证,验证登录计算机是否存在于COMPUTER表中,计算机的验证通
过计算机名,硬盘序列号,网卡物理地址,IP地址这四项的组合进行验证,具体组合
可以系统策略中配置;
5. 如果验证未通过,返回false,并在客户端日志中记录登录失败的原因
接口声明:
相关数据表:
输入参数:
输出参数:
返回值及异常:
参见
返回值不变。
捕获到异常,请对异常进行分析。
如果异常类型是***
2.2 接口名NO.2
接口功能:
接口声明:相关数据表:输入参数: 输出参数:返回值及异常:。