cn.stylefeng.roses.kernel.auth.api

接口 AuthServiceApi

public interface AuthServiceApi

认证服务的接口，包括基本的登录退出操作和校验token等操作

作者:

fengshuonan

方法概要

限定符和类型	方法和说明
void	cancelFreeze(LoginRequest loginRequest) 取消冻结帐号
void	checkAuth(String token, String requestUrl) 校验用户是否认证通过，认证是校验token的过程，校验失败会抛出异常
LoginUser	createNewLoginInfo(String token, String account) 为指定token创建新的登录信息
LoginResponse	login(LoginRequest loginRequest) 常规登录操作
LoginResponse	LoginWithToken(LoginWithTokenRequest loginWithTokenRequest) 通过token进行登录，一般用在单点登录服务
LoginResponse	loginWithUserName(String username) 登录（直接用账号登录），一般用在第三方登录
LoginResponse	loginWithUserNameAndCaToken(String username, String caToken) 登录（通过账号和sso后的token），一般用在单点登录
void	logout() 当前登录人退出登录
void	logoutWithToken(String token) 移除某个token，也就是退出某个用户
DefaultJwtPayload	validateToken(String token) 校验jwt token的正确性，调用jwt工具类相关方法校验 结果有三种，第一是jwt过期了，第二是用户随便写的错误token，第三种是token正确，token正确不会抛出异常

方法详细资料

login

LoginResponse login(LoginRequest loginRequest)

常规登录操作

参数:

loginRequest - 登录的请求

返回:

token 一般为jwt token

loginWithUserName

LoginResponse loginWithUserName(String username)

登录（直接用账号登录），一般用在第三方登录

参数:

username - 账号

loginWithUserNameAndCaToken

LoginResponse loginWithUserNameAndCaToken(String username,
                                          String caToken)

登录（通过账号和sso后的token），一般用在单点登录

参数:

username - 账号

caToken - sso登录成功后的会话

LoginWithToken

LoginResponse LoginWithToken(LoginWithTokenRequest loginWithTokenRequest)

通过token进行登录，一般用在单点登录服务

参数:

loginWithTokenRequest - 请求

logout

void logout()

当前登录人退出登录

logoutWithToken

void logoutWithToken(String token)

移除某个token，也就是退出某个用户

参数:

token - 某个用户的登录token

validateToken

DefaultJwtPayload validateToken(String token)
                         throws AuthException

校验jwt token的正确性，调用jwt工具类相关方法校验

结果有三种，第一是jwt过期了，第二是用户随便写的错误token，第三种是token正确，token正确不会抛出异常

参数:

token - 某个用户的登录token

返回:

token解析出的用户基本信息

抛出:

AuthException - 认证异常，如果token错误或过期，会有相关的异常抛出

checkAuth

void checkAuth(String token,
               String requestUrl)

校验用户是否认证通过，认证是校验token的过程，校验失败会抛出异常

参数:

token - 用户登陆的token

requestUrl - 被校验的url

cancelFreeze

void cancelFreeze(LoginRequest loginRequest)

取消冻结帐号

createNewLoginInfo

LoginUser createNewLoginInfo(String token,
                             String account)

为指定token创建新的登录信息

参数:

token - 用户旧的token

account - 用户账号

返回:

新的当前登录用户