smartbi.usermanager.auth

接口 IAuthentication

public interface IAuthentication

此类为第三方登录验证方案时需要实现的接口。

方法概要

方法

限定符和类型	方法和说明
boolean	changePassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword) 设置用户的密码
void	config(ServletContext ctx) 配置登录验证类
UserInfo	getUser(java.lang.String userName) 获取用户的名称、别名、密码、描述、所属组、拥有的角色等信息
boolean	isPasswordValidate(java.lang.String userName, java.lang.String password) 判断登录用户名、密码是否正确
boolean	shallUserValidateInAuthentication(java.lang.String userName) 是否应该在本类中验证此用户的密码

方法详细资料

config

void config(ServletContext ctx)
            throws java.io.IOException

配置登录验证类

参数:

ctx - 应用的上下文对象

抛出:

java.io.IOException - 当出现初始化错误时。

shallUserValidateInAuthentication

boolean shallUserValidateInAuthentication(java.lang.String userName)
                                          throws java.io.IOException

是否应该在本类中验证此用户的密码

参数:

userName - 用户名

返回:

如果返回true，表示该用户的密码在本类中验证；如果返回false，表示该用户的密码在知识库中验证

抛出:

java.io.IOException - 当出现通信异常时抛出

isPasswordValidate

boolean isPasswordValidate(java.lang.String userName,
                         java.lang.String password)
                           throws java.io.IOException

判断登录用户名、密码是否正确

参数:

userName - 用户名

password - 密码

返回:

如果登录成功则返回true，如果失败则返回false

抛出:

java.io.IOException - 当出现通信异常时抛出

getUser

UserInfo getUser(java.lang.String userName)
                 throws java.io.IOException,
                        UserNotExistException

获取用户的名称、别名、密码、描述、所属组、拥有的角色等信息

参数:

userName - 用户名

返回:

指定用户的信息

抛出:

java.io.IOException - 当出现通信异常时抛出

UserNotExistException - 如果抛出此异常，系统会删除此用户

changePassword

boolean changePassword(java.lang.String userName,
                     java.lang.String oldPassword,
                     java.lang.String newPassword)
                       throws java.io.IOException,
                              java.lang.UnsupportedOperationException

设置用户的密码

参数:

oldPassword - 旧密码

newPassword - 新密码

返回:

返回设置用户密码是否成功

抛出:

java.io.IOException - 当出现通信异常时抛出

java.lang.UnsupportedOperationException - 当该用户验证类不支持此操作时抛出